Communication protocols in integrated systems

ABSTRACT

A system and methods comprise a touchscreen at a premises. The touchscreen includes a processor coupled to a security system at the premises. User interfaces are presented via the touchscreen and include a security interface that provides control of functions of and access to data collected by the security system, and a network interface that provides access to network devices. A plurality of network devices at the premises is coupled to the touchscreen. A security server at a remote location is coupled to the touchscreen. The security server comprises a client interface through which remote client devices exchange data with the touchscreen and the security system. The client interface is a cross-client interface provided by a client view model of at least one of the touchscreen and the security server that normalizes information of the plurality of network devices and the security system.

RELATED APPLICATIONS

This application claims the benefit of U.S. Patent Application No.61/782,345, filed Mar. 14, 2013.

This application claims the benefit of U.S. Patent Application No.61/802,077, filed Mar. 15, 2013.

This application claims the benefit of U.S. Patent Application No.61/777,061, filed Mar. 12, 2013.

This application claims the benefit of U.S. Patent Application No.61/778,853, filed Mar. 13, 2013.

This application claims the benefit of U.S. Patent Application No.61/779,028, filed Mar. 13, 2013.

This application claims the benefit of U.S. Patent Application No.61/779,753, filed Mar. 13, 2013.

This application claims the benefit of U.S. Patent Application No.61/780,092, filed Mar. 13, 2013.

This application claims the benefit of U.S. Patent Application No.61/780,290, filed Mar. 13, 2013.

This application claims the benefit of U.S. Patent Application No.61/780,435, filed Mar. 13, 2013.

This application claims the benefit of U.S. Patent Application No.61/780,538, filed Mar. 13, 2013.

This application claims the benefit of U.S. Patent Application No.61/780,637, filed Mar. 13, 2013.

This application claims the benefit of U.S. Patent Application No.61/781,401, filed Mar. 14, 2013.

This application claims the benefit of U.S. Patent Application No.61/781,713, filed Mar. 14, 2013.

This application is a continuation in part application of U.S. patentapplication Ser. No. 12/197,946, filed Aug. 25, 2008.

This application is a continuation in part application of U.S. patentapplication Ser. No. 13/718,851, filed Dec. 18, 2012.

This application is a continuation in part application of U.S. patentapplication Ser. No. 13/932,837, filed Jul. 1, 2013.

This application is a continuation in part application of U.S. patentapplication Ser. No. 11/761,745, filed Jun. 12, 2007.

This application is a continuation in part application of U.S. patentapplication Ser. No. 12/019,568, filed Jan. 24, 2008.

This application is a continuation in part application of U.S. patentapplication Ser. No. 13/925,181, filed Jun. 24, 2013.

This application is a continuation in part application of U.S. patentapplication Ser. No. 13/531,757, filed Jun. 25, 2012.

This application is a continuation in part application of U.S. patentapplication Ser. No. 13/335,279, filed Dec. 22, 2011.

This application is a continuation in part application of U.S. patentapplication Ser. No. 12/539,537, filed Aug. 11, 2009.

This application is a continuation in part application of U.S. patentapplication Ser. No. 12/750,470, filed Mar. 30, 2010.

This application is a continuation in part application of U.S. patentapplication Ser. No. 13/104,932, filed May 10, 2011.

TECHNICAL FIELD

The embodiments described herein relate generally to a method andapparatus for improving the capabilities of security systems in home andbusiness applications. More particularly, the embodiments describedherein relate to a touchscreen device that integrates security systemcontrol and functionality with network content interactivity, managementand presentation.

BACKGROUND

The field of home and small business security is dominated by technologysuppliers who build comprehensive ‘closed’ security systems, where theindividual components (sensors, security panels, keypads) operate solelywithin the confines of a single vendor solution. For example, a wirelessmotion sensor from vendor A cannot be used with a security panel fromvendor B. Each vendor typically has developed sophisticated proprietarywireless technologies to enable the installation and management ofwireless sensors, with little or no ability for the wireless devices tooperate separate from the vendor's homogeneous system. Furthermore,these traditional systems are extremely limited in their ability tointerface either to a local or wide area standards-based network (suchas an IP network); most installed systems support only a low-bandwidth,intermittent connection utilizing phone lines or cellular (RF) backupsystems. Wireless security technology from providers such as GESecurity, Honeywell, and DSC/Tyco are well known in the art, and areexamples of this proprietary approach to security systems for home andbusiness.

Furthermore, with the proliferation of the internet, ethernet and WiFilocal area networks (LANs) and advanced wide area networks (WANs) thatoffer high bandwidth, low latency connections (broadband), as well asmore advanced wireless WAN data networks (e.g. GPRS or CDMA 1×RTT) thereincreasingly exists the networking capability to extend thesetraditional security systems to offer enhanced functionality. Inaddition, the proliferation of broadband access has driven acorresponding increase in home and small business networkingtechnologies and devices. It is desirable to extend traditional securitysystems to encompass enhanced functionality such as the ability tocontrol and manage security systems from the world wide web, cellulartelephones, or advanced function internet-based devices. Other desiredfunctionality includes an open systems approach to interface homesecurity systems to home and small business networks.

Due to the proprietary approach described above, the traditional vendorsare the only ones capable of taking advantage of these new networkfunctions. To date, even though the vast majority of home and businesscustomers have broadband network access in their premises, most securitysystems do not offer the advanced capabilities associated with highspeed, low-latency LANs and WANs. This is primarily because theproprietary vendors have not been able to deliver such technologyefficiently or effectively. Solution providers attempting to addressthis need are becoming known in the art, including three categories ofvendors: traditional proprietary hardware providers such as Honeywelland GE Security; third party hard-wired module providers such asAlarm.com, NextAlarm, and uControl; and new proprietary systemsproviders such as InGrid.

A disadvantage of the prior art technologies of the traditionalproprietary hardware providers arises due to the continued proprietaryapproach of these vendors. As they develop technology in this area itonce again operates only with the hardware from that specific vendor,ignoring the need for a heterogeneous, cross-vendor solution. Yetanother disadvantage of the prior art technologies of the traditionalproprietary hardware providers arises due to the lack of experience andcapability of these companies in creating open internet and web basedsolutions, and consumer friendly interfaces.

A disadvantage of the prior art technologies of the third partyhard-wired module providers arises due to the installation andoperational complexities and functional limitations associated withhardwiring a new component into existing security systems. Moreover, adisadvantage of the prior art technologies of the new proprietarysystems providers arises due to the need to discard all priortechnologies, and implement an entirely new form of security system toaccess the new functionalities associated with broadband and wirelessdata networks. There remains, therefore, a need for systems, devices,and methods that easily interface to and control the existingproprietary security technologies utilizing a variety of wirelesstechnologies.

INCORPORATION BY REFERENCE

Each patent, patent application, and/or publication mentioned in thisspecification is herein incorporated by reference in its entirety to thesame extent as if each individual patent, patent application, and/orpublication was specifically and individually indicated to beincorporated by reference.

BRIEF DESCRIPTION OF THE DRAWINGS

FIG. 1 is a block diagram of the integrated security system, under anembodiment.

FIG. 2 is a block diagram of components of the integrated securitysystem, under an embodiment.

FIG. 3 is a block diagram of the gateway software or applications, underan embodiment.

FIG. 4 is a block diagram of the gateway components, under anembodiment.

FIG. 5 is a block diagram of IP device integration with a premisenetwork, under an embodiment.

FIG. 6 is a block diagram of IP device integration with a premisenetwork, under an alternative embodiment.

FIG. 7 is a block diagram of a touchscreen, under an embodiment.

FIG. 8 is an example screenshot of a networked security touchscreen,under an embodiment.

FIG. 9 is a block diagram of network or premise device integration witha premise network, under an embodiment.

FIG. 10 is a block diagram of network or premise device integration witha premise network, under an alternative embodiment.

FIG. 11 is a flow diagram for a method of forming a security networkincluding integrated security system components, under an embodiment.

FIG. 12 is a flow diagram for a method of forming a security networkincluding integrated security system components and network devices,under an embodiment.

FIG. 13 is a flow diagram for installation of an IP device into aprivate network environment, under an embodiment.

FIG. 14 is a block diagram showing communications among IP devices ofthe private network environment, under an embodiment.

FIG. 15 is a flow diagram of a method of integrating an external controland management application system with an existing security system,under an embodiment.

FIG. 16 is a block diagram of an integrated security system wirelesslyinterfacing to proprietary security systems, under an embodiment.

FIG. 17 is a flow diagram for wirelessly ‘learning’ the gateway into anexisting security system and discovering extant sensors, under anembodiment.

FIG. 18 is a block diagram of a security system in which the legacypanel is replaced with a wireless security panel wirelessly coupled to agateway, under an embodiment.

FIG. 19 is a block diagram of a security system in which the legacypanel is replaced with a wireless security panel wirelessly coupled to agateway, and a touchscreen, under an alternative embodiment.

FIG. 20 is a block diagram of a security system in which the legacypanel is replaced with a wireless security panel connected to a gatewayvia an Ethernet coupling, under another alternative embodiment.

FIG. 21 is a flow diagram for automatic takeover of a security system,under an embodiment.

FIG. 22 is a flow diagram for automatic takeover of a security system,under an alternative embodiment.

FIG. 23 is a general flow diagram for IP video control, under anembodiment.

FIG. 24 is a block diagram showing camera tunneling, under anembodiment.

FIG. 25 is a block diagram of a sign out link, under an embodiment.

FIG. 26 is a block diagram illustrating selection of thermostat modes,under an embodiment.

FIG. 27 is a block diagram of a toggle command, under an embodiment.

FIG. 28 is a block diagram of a range command, under an embodiment.

FIG. 29 is a block diagram of a text input command, under an embodiment.

FIG. 30 is a block diagram of a site object, under an embodiment.

FIG. 31 is a block diagram of a summary object which describes the orbor equivalent, and summary text that maybe shown, under an embodiment.

FIG. 32 is a block diagram of a security object which holds the securitycommands to arm and disarm, under an embodiment.

FIG. 33 is a block diagram of a shift object, under an embodiment.

FIG. 34 is a block diagram of a messaging object, under an embodiment.

FIG. 35 is a block diagram of a home view settings object, under anembodiment.

FIG. 36 is a block diagram illustrating group home view data, under anembodiment.

FIGS. 37A and 37B are a block diagram of group lighting, under anembodiment.

FIG. 38 is a block diagram of group thermostat, under an embodiment.

FIG. 39 is a block diagram of group camera, under an embodiment.

FIG. 40 is a block diagram of a group energyMeter, under an embodiment.

DETAILED DESCRIPTION

An integrated security system is described that integrates broadband andmobile access and control with conventional security systems and premisedevices to provide a tri-mode security network (broadband, cellular/GSM,POTS access) that enables users to remotely stay connected to theirpremises. The integrated security system, while delivering remotepremise monitoring and control functionality to conventional monitoredpremise protection, complements existing premise protection equipment.The integrated security system integrates into the premise network andcouples wirelessly with the conventional security panel, enablingbroadband access to premise security systems. Automation devices(cameras, lamp modules, thermostats, etc.) can be added, enabling usersto remotely see live video and/or pictures and control home devices viatheir personal web portal or webpage, mobile phone, and/or other remoteclient device. Users can also receive notifications via email or textmessage when happenings occur, or do not occur, in their home.

Although the detailed description herein contains many specifics for thepurposes of illustration, anyone of ordinary skill in the art willappreciate that many variations and alterations to the following detailsare within the scope of the embodiments described herein. Thus, thefollowing illustrative embodiments are set forth without any loss ofgenerality to, and without imposing limitations upon, the claimedinvention.

As described herein, computer networks suitable for use with theembodiments described herein include local area networks (LAN), widearea networks (WAN), Internet, or other connection services and networkvariations such as the world wide web, the public internet, a privateinternet, a private computer network, a public network, a mobilenetwork, a cellular network, a value-added network, and the like.Computing devices coupled or connected to the network may be anymicroprocessor controlled device that permits access to the network,including terminal devices, such as personal computers, workstations,servers, mini computers, main-frame computers, laptop computers, mobilecomputers, palm top computers, hand held computers, mobile phones, TVset-top boxes, or combinations thereof. The computer network may includeone of more LANs, WANs, Internets, and computers. The computers mayserve as servers, clients, or a combination thereof.

The integrated security system can be a component of a single system,multiple systems, and/or geographically separate systems. The integratedsecurity system can also be a subcomponent or subsystem of a singlesystem, multiple systems, and/or geographically separate systems. Theintegrated security system can be coupled to one or more othercomponents (not shown) of a host system or a system coupled to the hostsystem.

One or more components of the integrated security system and/or acorresponding system or application to which the integrated securitysystem is coupled or connected includes and/or runs under and/or inassociation with a processing system. The processing system includes anycollection of processor-based devices or computing devices operatingtogether, or components of processing systems or devices, as is known inthe art. For example, the processing system can include one or more of aportable computer, portable communication device operating in acommunication network, and/or a network server. The portable computercan be any of a number and/or combination of devices selected from amongpersonal computers, personal digital assistants, portable computingdevices, and portable communication devices, but is not so limited. Theprocessing system can include components within a larger computersystem.

The processing system of an embodiment includes at least one processorand at least one memory device or subsystem. The processing system canalso include or be coupled to at least one database. The term“processor” as generally used herein refers to any logic processingunit, such as one or more central processing units (CPUs), digitalsignal processors (DSPs), application-specific integrated circuits(ASIC), etc. The processor and memory can be monolithically integratedonto a single chip, distributed among a number of chips or components,and/or provided by some combination of algorithms. The methods describedherein can be implemented in one or more of software algorithm(s),programs, firmware, hardware, components, circuitry, in any combination.

The components of any system that includes the integrated securitysystem can be located together or in separate locations. Communicationpaths couple the components and include any medium for communicating ortransferring files among the components. The communication paths includewireless connections, wired connections, and hybrid wireless/wiredconnections. The communication paths also include couplings orconnections to networks including local area networks (LANs),metropolitan area networks (MANs), wide area networks (WANs),proprietary networks, interoffice or backend networks, and the Internet.Furthermore, the communication paths include removable fixed mediumslike floppy disks, hard disk drives, and CD-ROM disks, as well as flashRAM, Universal Serial Bus (USB) connections, RS-232 connections,telephone lines, buses, and electronic mail messages.

Aspects of the integrated security system and corresponding systems andmethods described herein may be implemented as functionality programmedinto any of a variety of circuitry, including programmable logic devices(PLDs), such as field programmable gate arrays (FPGAs), programmablearray logic (PAL) devices, electrically programmable logic and memorydevices and standard cell-based devices, as well as application specificintegrated circuits (ASICs). Some other possibilities for implementingaspects of the integrated security system and corresponding systems andmethods include: microcontrollers with memory (such as electronicallyerasable programmable read only memory (EEPROM)), embeddedmicroprocessors, firmware, software, etc. Furthermore, aspects of theintegrated security system and corresponding systems and methods may beembodied in microprocessors having software-based circuit emulation,discrete logic (sequential and combinatorial), custom devices, fuzzy(neural) logic, quantum devices, and hybrids of any of the above devicetypes. Of course the underlying device technologies may be provided in avariety of component types, e.g., metal-oxide semiconductor field-effecttransistor (MOSFET) technologies like complementary metal-oxidesemiconductor (CMOS), bipolar technologies like emitter-coupled logic(ECL), polymer technologies (e.g., silicon-conjugated polymer andmetal-conjugated polymer-metal structures), mixed analog and digital,etc.

It should be noted that any system, method, and/or other componentsdisclosed herein may be described using computer aided design tools andexpressed (or represented), as data and/or instructions embodied invarious computer-readable media, in terms of their behavioral, registertransfer, logic component, transistor, layout geometries, and/or othercharacteristics. Computer-readable media in which such formatted dataand/or instructions may be embodied include, but are not limited to,non-volatile storage media in various forms (e.g., optical, magnetic orsemiconductor storage media) and carrier waves that may be used totransfer such formatted data and/or instructions through wireless,optical, or wired signaling media or any combination thereof. Examplesof transfers of such formatted data and/or instructions by carrier wavesinclude, but are not limited to, transfers (uploads, downloads, e-mail,etc.) over the Internet and/or other computer networks via one or moredata transfer protocols (e.g., HTTP, FTP, SMTP, etc.). When receivedwithin a computer system via one or more computer-readable media, suchdata and/or instruction-based expressions of the above describedcomponents may be processed by a processing entity (e.g., one or moreprocessors) within the computer system in conjunction with execution ofone or more other computer programs.

Unless the context clearly requires otherwise, throughout thedescription and the claims, the words “comprise,” “comprising,” and thelike are to be construed in an inclusive sense as opposed to anexclusive or exhaustive sense; that is to say, in a sense of “including,but not limited to.” Words using the singular or plural number alsoinclude the plural or singular number respectively. Additionally, thewords “herein,” “hereunder,” “above,” “below,” and words of similarimport, when used in this application, refer to this application as awhole and not to any particular portions of this application. When theword “or” is used in reference to a list of two or more items, that wordcovers all of the following interpretations of the word: any of theitems in the list, all of the items in the list and any combination ofthe items in the list.

The above description of embodiments of the integrated security systemand corresponding systems and methods is not intended to be exhaustiveor to limit the systems and methods to the precise forms disclosed.While specific embodiments of, and examples for, the integrated securitysystem and corresponding systems and methods are described herein forillustrative purposes, various equivalent modifications are possiblewithin the scope of the systems and methods, as those skilled in therelevant art will recognize. The teachings of the integrated securitysystem and corresponding systems and methods provided herein can beapplied to other systems and methods, not only for the systems andmethods described above.

The elements and acts of the various embodiments described above can becombined to provide further embodiments. These and other changes can bemade to the integrated security system and corresponding systems andmethods in light of the above detailed description.

In accordance with the embodiments described herein, a wireless system(e.g., radio frequency (RF)) is provided that enables a securityprovider or consumer to extend the capabilities of an existingRF-capable security system or a non-RF-capable security system that hasbeen upgraded to support RF capabilities. The system includes anRF-capable Gateway device (physically located within RF range of theRF-capable security system) and associated software operating on theGateway device. The system also includes a web server, applicationserver, and remote database providing a persistent store for informationrelated to the system.

The security systems of an embodiment, referred to herein as theiControl security system or integrated security system, extend the valueof traditional home security by adding broadband access and theadvantages of remote home monitoring and home control through theformation of a security network including components of the integratedsecurity system integrated with a conventional premise security systemand a premise local area network (LAN). With the integrated securitysystem, conventional home security sensors, cameras, touchscreenkeypads, lighting controls, and/or Internet Protocol (IP) devices in thehome (or business) become connected devices that are accessible anywherein the world from a web browser, mobile phone or through content-enabledtouchscreens. The integrated security system experience allows securityoperators to both extend the value proposition of their monitoredsecurity systems and reach new consumers that include broadband usersinterested in staying connected to their family, home and property whenthey are away from home.

The integrated security system of an embodiment includes securityservers (also referred to herein as iConnect servers or security networkservers) and an iHub gateway (also referred to herein as the gateway,the iHub, or the iHub client) that couples or integrates into a homenetwork (e.g., LAN) and communicates directly with the home securitypanel, in both wired and wireless installations. The security system ofan embodiment automatically discovers the security system components(e.g., sensors, etc.) belonging to the security system and connected toa control panel of the security system and provides consumers with fulltwo-way access via web and mobile portals. The gateway supports variouswireless protocols and can interconnect with a wide range of controlpanels offered by security system providers. Service providers and userscan then extend the system's capabilities with the additional IPcameras, lighting modules or security devices such as interactivetouchscreen keypads. The integrated security system adds an enhancedvalue to these security systems by enabling consumers to stay connectedthrough email and SMS alerts, photo push, event-based video capture andrule-based monitoring and notifications. This solution extends the reachof home security to households with broadband access.

The integrated security system builds upon the foundation afforded bytraditional security systems by layering broadband and mobile access, IPcameras, interactive touchscreens, and an open approach to homeautomation on top of traditional security system configurations. Theintegrated security system is easily installed and managed by thesecurity operator, and simplifies the traditional security installationprocess, as described below.

The integrated security system provides an open systems solution to thehome security market. As such, the foundation of the integrated securitysystem customer premises equipment (CPE) approach has been to abstractdevices, and allows applications to manipulate and manage multipledevices from any vendor. The integrated security system DeviceConnecttechnology that enables this capability supports protocols, devices, andpanels from GE Security and Honeywell, as well as consumer devices usingZ-Wave, IP cameras (e.g., Ethernet, wifi, and Homeplug), and IPtouchscreens. The DeviceConnect is a device abstraction layer thatenables any device or protocol layer to interoperate with integratedsecurity system components. This architecture enables the addition ofnew devices supporting any of these interfaces, as well as add entirelynew protocols.

The benefit of DeviceConnect is that it provides supplier flexibility.The same consistent touchscreen, web, and mobile user experience operateunchanged on whatever security equipment selected by a security systemprovider, with the system provider's choice of IP cameras, backend datacenter and central station software.

The integrated security system provides a complete system thatintegrates or layers on top of a conventional host security systemavailable from a security system provider. The security system providertherefore can select different components or configurations to offer(e.g., CDMA, GPRS, no cellular, etc.) as well as have iControl modifythe integrated security system configuration for the system provider'sspecific needs (e.g., change the functionality of the web or mobileportal, add a GE or Honeywell-compatible TouchScreen, etc.).

The integrated security system integrates with the security systemprovider infrastructure for central station reporting directly viaBroadband and GPRS alarm transmissions. Traditional dial-up reporting issupported via the standard panel connectivity. Additionally, theintegrated security system provides interfaces for advancedfunctionality to the CMS, including enhanced alarm events, systeminstallation optimizations, system test verification, videoverification, 2-way voice over IP and GSM.

The integrated security system is an IP centric system that includesbroadband connectivity so that the gateway augments the existingsecurity system with broadband and GPRS connectivity. If broadband isdown or unavailable GPRS may be used, for example. The integratedsecurity system supports GPRS connectivity using an optional wirelesspackage that includes a GPRS modem in the gateway. The integratedsecurity system treats the GPRS connection as a higher cost thoughflexible option for data transfers. In an embodiment the GPRS connectionis only used to route alarm events (e.g., for cost), however the gatewaycan be configured (e.g., through the iConnect server interface) to actas a primary channel and pass any or all events over GPRS. Consequently,the integrated security system does not interfere with the current plainold telephone service (POTS) security panel interface. Alarm events canstill be routed through POTS; however the gateway also allows suchevents to be routed through a broadband or GPRS connection as well. Theintegrated security system provides a web application interface to theCSR tool suite as well as XML web services interfaces for programmaticintegration between the security system provider's existing call centerproducts. The integrated security system includes, for example, APIsthat allow the security system provider to integrate components of theintegrated security system into a custom call center interface. The APIsinclude XML web service APIs for integration of existing security systemprovider call center applications with the integrated security systemservice. All functionality available in the CSR Web application isprovided with these API sets. The Java and XML-based APIs of theintegrated security system support provisioning, billing, systemadministration, CSR, central station, portal user interfaces, andcontent management functions, to name a few. The integrated securitysystem can provide a customized interface to the security systemprovider's billing system, or alternatively can provide security systemdevelopers with APIs and support in the integration effort.

The integrated security system provides or includes business componentinterfaces for provisioning, administration, and customer care to name afew. Standard templates and examples are provided with a definedcustomer professional services engagement to help integrate OSS/BSSsystems of a Service Provider with the integrated security system.

The integrated security system components support and allow for theintegration of customer account creation and deletion with a securitysystem. The iConnect APIs provides access to the provisioning andaccount management system in iConnect and provide full support foraccount creation, provisioning, and deletion. Depending on therequirements of the security system provider, the iConnect APIs can beused to completely customize any aspect of the integrated securitysystem backend operational system.

The integrated security system includes a gateway that supports thefollowing standards-based interfaces, to name a few: Ethernet IPcommunications via Ethernet ports on the gateway, and standardXML/TCP/IP protocols and ports are employed over secured SSL sessions;USB 2.0 via ports on the gateway; 802.11b/g/n IP communications;GSM/GPRS RF WAN communications; CDMA 1×RTT RF WAN communications(optional, can also support EVDO and 3G technologies).

The gateway supports the following proprietary interfaces, to name afew: interfaces including Dialog RF network (319.5 MHz) and RS485Superbus 2000 wired interface; RF mesh network (908 MHz); and interfacesincluding RF network (345 MHz) and RS485/RS232bus wired interfaces.

Regarding security for the IP communications (e.g., authentication,authorization, encryption, anti-spoofing, etc), the integrated securitysystem uses SSL to encrypt all IP traffic, using server andclient-certificates for authentication, as well as authentication in thedata sent over the SSL-encrypted channel. For encryption, integratedsecurity system issues public/private key pairs at the time/place ofmanufacture, and certificates are not stored in any online storage in anembodiment.

The integrated security system does not need any special rules at thecustomer premise and/or at the security system provider central stationbecause the integrated security system makes outgoing connections usingTCP over the standard HTTP and HTTPS ports. Provided outbound TCPconnections are allowed then no special requirements on the firewallsare necessary.

FIG. 1 is a block diagram of the integrated security system 100, underan embodiment. The integrated security system 100 of an embodimentincludes the gateway 102 and the security servers 104 coupled to theconventional home security system 110. At a customer's home or business,the gateway 102 connects and manages the diverse variety of homesecurity and self-monitoring devices. The gateway 102 communicates withthe iConnect Servers 104 located in the service provider's data center106 (or hosted in integrated security system data center), with thecommunication taking place via a communication network 108 or othernetwork (e.g., cellular network, internet, etc.). These servers 104manage the system integrations necessary to deliver the integratedsystem service described herein. The combination of the gateway 102 andthe iConnect servers 104 enable a wide variety of remote client devices120 (e.g., PCs, mobile phones and PDAs) allowing users to remotely stayin touch with their home, business and family. In addition, thetechnology allows home security and self-monitoring information, as wellas relevant third party content such as traffic and weather, to bepresented in intuitive ways within the home, such as on advancedtouchscreen keypads.

The integrated security system service (also referred to as iControlservice) can be managed by a service provider via browser-basedMaintenance and Service Management applications that are provided withthe iConnect Servers. Or, if desired, the service can be more tightlyintegrated with existing OSS/BSS and service delivery systems via theiConnect web services-based XML APIs.

The integrated security system service can also coordinate the sendingof alarms to the home security Central Monitoring Station (CMS) 199.Alarms are passed to the CMS 199 using standard protocols such asContact ID or SIA and can be generated from the home security panellocation as well as by iConnect server 104 conditions (such as lack ofcommunications with the integrated security system). In addition, thelink between the security servers 104 and CMS 199 provides tighterintegration between home security and self-monitoring devices and thegateway 102. Such integration enables advanced security capabilitiessuch as the ability for CMS personnel to view photos taken at the time aburglary alarm was triggered. For maximum security, the gateway 102 andiConnect servers 104 support the use of a mobile network (both GPRS andCDMA options are available) as a backup to the primary broadbandconnection.

The integrated security system service is delivered by hosted serversrunning software components that communicate with a variety of clienttypes while interacting with other systems. FIG. 2 is a block diagram ofcomponents of the integrated security system 100, under an embodiment.Following is a more detailed description of the components.

The iConnect servers 104 support a diverse collection of clients 120ranging from mobile devices, to PCs, to in-home security devices, to aservice provider's internal systems. Most clients 120 are used byend-users, but there are also a number of clients 120 that are used tooperate the service.

Clients 120 used by end-users of the integrated security system 100include, but are not limited to, the following:

-   -   Clients based on gateway client applications 202 (e.g., a        processor-based device running the gateway technology that        manages home security and automation devices).    -   A web browser 204 accessing a Web Portal application, performing        end-user configuration and customization of the integrated        security system service as well as monitoring of in-home device        status, viewing photos and video, etc. Device and user        management can also be performed by this portal application.    -   A mobile device 206 (e.g., PDA, mobile phone, etc.) accessing        the integrated security system Mobile Portal. This type of        client 206 is used by end-users to view system status and        perform operations on devices (e.g., turning on a lamp, arming a        security panel, etc.) rather than for system configuration tasks        such as adding a new device or user.    -   PC or browser-based “widget” containers 208 that present        integrated security system service content, as well as other        third-party content, in simple, targeted ways (e.g. a widget        that resides on a PC desktop and shows live video from a single        in-home camera). “Widget” as used herein means applications or        programs in the system.    -   Touchscreen home security keypads 208 and advanced in-home        devices that present a variety of content widgets via an        intuitive touchscreen user interface.    -   Notification recipients 210 (e.g., cell phones that receive        SMS-based notifications when certain events occur (or don't        occur), email clients that receive an email message with similar        information, etc.).    -   Custom-built clients (not shown) that access the iConnect web        services XML API to interact with users' home security and        self-monitoring information in new and unique ways. Such clients        could include new types of mobile devices, or complex        applications where integrated security system content is        integrated into a broader set of application features.

In addition to the end-user clients, the iConnect servers 104 support PCbrowser-based Service Management clients that manage the ongoingoperation of the overall service. These clients run applications thathandle tasks such as provisioning, service monitoring, customer supportand reporting.

There are numerous types of server components of the iConnect servers104 of an embodiment including, but not limited to, the following:Business Components which manage information about all of the homesecurity and self-monitoring devices; End-User Application Componentswhich display that information for users and access the BusinessComponents via published XML APIs; and Service Management ApplicationComponents which enable operators to administer the service (thesecomponents also access the Business Components via the XML APIs, andalso via published SNMP MIBs).

The server components provide access to, and management of, the objectsassociated with an integrated security system installation. Thetop-level object is the “network.” It is a location where a gateway 102is located, and is also commonly referred to as a site or premises; thepremises can include any type of structure (e.g., home, office,warehouse, etc.) at which a gateway 102 is located. Users can onlyaccess the networks to which they have been granted permission. Within anetwork, every object monitored by the gateway 102 is called a device.Devices include the sensors, cameras, home security panels andautomation devices, as well as the controller or processor-based devicerunning the gateway applications.

Various types of interactions are possible between the objects in asystem. Automations define actions that occur as a result of a change instate of a device. For example, take a picture with the front entrycamera when the front door sensor changes to “open”. Notifications aremessages sent to users to indicate that something has occurred, such asthe front door going to “open” state, or has not occurred (referred toas an iWatch notification). Schedules define changes in device statesthat are to take place at predefined days and times. For example, setthe security panel to “Armed” mode every weeknight at 11:00 pm.

The iConnect Business Components are responsible for orchestrating allof the low-level service management activities for the integratedsecurity system service. They define all of the users and devicesassociated with a network (site), analyze how the devices interact, andtrigger associated actions (such as sending notifications to users). Allchanges in device states are monitored and logged. The BusinessComponents also manage all interactions with external systems asrequired, including sending alarms and other related self-monitoringdata to the home security Central Monitoring System (CMS) 199. TheBusiness Components are implemented as portable Java J2EE Servlets, butare not so limited.

The following iConnect Business Components manage the main elements ofthe integrated security system service, but the embodiment is not solimited:

-   -   A Registry Manager 220 defines and manages users and networks.        This component is responsible for the creation, modification and        termination of users and networks. It is also where a user's        access to networks is defined.    -   A Network Manager 222 defines and manages security and        self-monitoring devices that are deployed on a network (site).        This component handles the creation, modification, deletion and        configuration of the devices, as well as the creation of        automations, schedules and notification rules associated with        those devices.    -   A Data Manager 224 manages access to current and logged state        data for an existing network and its devices. This component        specifically does not provide any access to network management        capabilities, such as adding new devices to a network, which are        handled exclusively by the Network Manager 222.    -   To achieve optimal performance for all types of queries, data        for current device states is stored separately from historical        state data (a.k.a. “logs”) in the database. A Log Data Manager        226 performs ongoing transfers of current device state data to        the historical data log tables.

Additional iConnect Business Components handle direct communicationswith certain clients and other systems, for example:

-   -   An iHub Manager 228 directly manages all communications with        gateway clients, including receiving information about device        state changes, changing the configuration of devices, and        pushing new versions of the gateway client to the hardware it is        running on.    -   A Notification Manager 230 is responsible for sending all        notifications to clients via SMS (mobile phone messages), email        (via a relay server like an SMTP email server), etc.    -   An Alarm and CMS Manager 232 sends critical server-generated        alarm events to the home security Central Monitoring Station        (CMS) and manages all other communications of integrated        security system service data to and from the CMS.    -   The Element Management System (EMS) 234 is an iControl Business        Component that manages all activities associated with service        installation, scaling and monitoring, and filters and packages        service operations data for use by service management        applications. The SNMP MIBs published by the EMS can also be        incorporated into any third party monitoring system if desired.

The iConnect Business Components store information about the objectsthat they manage in the iControl Service Database 240 and in theiControl Content Store 242. The iControl Content Store is used to storemedia objects like video, photos and widget content, while the ServiceDatabase stores information about users, networks, and devices. Databaseinteraction is performed via a JDBC interface. For security purposes,the Business Components manage all data storage and retrieval.

The iControl Business Components provide web services-based APIs thatapplication components use to access the Business Components'capabilities. Functions of application components include presentingintegrated security system service data to end-users, performingadministrative duties, and integrating with external systems andback-office applications.

The primary published APIs for the iConnect Business Components include,but are not limited to, the following:

-   -   A Registry Manager API 252 provides access to the Registry        Manager Business Component's functionality, allowing management        of networks and users.    -   A Network Manager API 254 provides access to the Network Manager        Business Component's functionality, allowing management of        devices on a network.    -   A Data Manager API 256 provides access to the Data Manager        Business Component's functionality, such as setting and        retrieving (current and historical) data about device states.    -   A Provisioning API 258 provides a simple way to create new        networks and configure initial default properties.

Each API of an embodiment includes two modes of access: Java API or XMLAPI. The XML APIs are published as web services so that they can beeasily accessed by applications or servers over a network. The Java APIsare a programmer-friendly wrapper for the XML APIs. Applicationcomponents and integrations written in Java should generally use theJava APIs rather than the XML APIs directly.

The iConnect Business Components also have an XML-based interface 260for quickly adding support for new devices to the integrated securitysystem. This interface 260, referred to as DeviceConnect 260, is aflexible, standards-based mechanism for defining the properties of newdevices and how they can be managed. Although the format is flexibleenough to allow the addition of any type of future device, pre-definedXML profiles are currently available for adding common types of devicessuch as sensors (SensorConnect), home security panels (PanelConnect) andIP cameras (CameraConnect).

The iConnect End-User Application Components deliver the user interfacesthat run on the different types of clients supported by the integratedsecurity system service. The components are written in portable JavaJ2EE technology (e.g., as Java Servlets, as JavaServer Pages (JSPs),etc.) and they all interact with the iControl Business Components viathe published APIs.

The following End-User Application Components generate CSS-basedHTML/JavaScript that is displayed on the target client. Theseapplications can be dynamically branded with partner-specific logos andURL links (such as Customer Support, etc.). The End-User ApplicationComponents of an embodiment include, but are not limited to, thefollowing:

-   -   An iControl Activation Application 270 that delivers the first        application that a user sees when they set up the integrated        security system service. This wizard-based web browser        application securely associates a new user with a purchased        gateway and the other devices included with it as a kit (if        any). It primarily uses functionality published by the        Provisioning API.    -   An iControl Web Portal Application 272 runs on PC browsers and        delivers the web-based interface to the integrated security        system service. This application allows users to manage their        networks (e.g. add devices and create automations) as well as to        view/change device states, and manage pictures and videos.        Because of the wide scope of capabilities of this application,        it uses three different Business Component APIs that include the        Registry Manager API, Network Manager API, and Data Manager API,        but the embodiment is not so limited.    -   An iControl Mobile Portal 274 is a small-footprint web-based        interface that runs on mobile phones and PDAs. This interface is        optimized for remote viewing of device states and        pictures/videos rather than network management. As such, its        interaction with the Business Components is primarily via the        Data Manager API.    -   Custom portals and targeted client applications can be provided        that leverage the same Business Component APIs used by the above        applications.    -   A Content Manager Application Component 276 delivers content to        a variety of clients. It sends multimedia-rich user interface        components to widget container clients (both PC and        browser-based), as well as to advanced touchscreen keypad        clients. In addition to providing content directly to end-user        devices, the Content Manager 276 provides widget-based user        interface components to satisfy requests from other Application        Components such as the iControl Web 272 and Mobile 274 portals.

A number of Application Components are responsible for overallmanagement of the service. These pre-defined applications, referred toas Service Management Application Components, are configured to offeroff-the-shelf solutions for production management of the integratedsecurity system service including provisioning, overall servicemonitoring, customer support, and reporting, for example. The ServiceManagement Application Components of an embodiment include, but are notlimited to, the following:

-   -   A Service Management Application 280 allows service        administrators to perform activities associated with service        installation, scaling and monitoring/alerting. This application        interacts heavily with the Element Management System (EMS)        Business Component to execute its functionality, and also        retrieves its monitoring data from that component via protocols        such as SNMP MIBs.    -   A Kitting Application 282 is used by employees performing        service provisioning tasks. This application allows home        security and self-monitoring devices to be associated with        gateways during the warehouse kitting process.    -   A CSR Application and Report Generator 284 is used by personnel        supporting the integrated security system service, such as CSRs        resolving end-user issues and employees enquiring about overall        service usage. The push of new gateway firmware to deployed        gateways is also managed by this application.

The iConnect servers 104 also support custom-built integrations with aservice provider's existing OSS/BSS, CSR and service delivery systems290. Such systems can access the iConnect web services XML API totransfer data to and from the iConnect servers 104. These types ofintegrations can compliment or replace the PC browser-based ServiceManagement applications, depending on service provider needs.

As described above, the integrated security system of an embodimentincludes a gateway, or iHub. The gateway of an embodiment includes adevice that is deployed in the home or business and couples or connectsthe various third-party cameras, home security panels, sensors anddevices to the iConnect server over a WAN connection as described indetail herein. The gateway couples to the home network and communicatesdirectly with the home security panel in both wired and wireless sensorinstallations. The gateway is configured to be low-cost, reliable andthin so that it complements the integrated security system network-basedarchitecture.

The gateway supports various wireless protocols and can interconnectwith a wide range of home security control panels. Service providers andusers can then extend the system's capabilities by adding IP cameras,lighting modules and additional security devices. The gateway isconfigurable to be integrated into many consumer appliances, includingset-top boxes, routers and security panels. The small and efficientfootprint of the gateway enables this portability and versatility,thereby simplifying and reducing the overall cost of the deployment.

FIG. 3 is a block diagram of the gateway 102 including gateway softwareor applications, under an embodiment. The gateway software architectureis relatively thin and efficient, thereby simplifying its integrationinto other consumer appliances such as set-top boxes, routers, touchscreens and security panels. The software architecture also provides ahigh degree of security against unauthorized access. This sectiondescribes the various key components of the gateway softwarearchitecture.

The gateway application layer 302 is the main program that orchestratesthe operations performed by the gateway. The Security Engine 304provides robust protection against intentional and unintentionalintrusion into the integrated security system network from the outsideworld (both from inside the premises as well as from the WAN). TheSecurity Engine 304 of an embodiment comprises one or more sub-modulesor components that perform functions including, but not limited to, thefollowing:

-   -   Encryption including 128-bit SSL encryption for gateway and        iConnect server communication to protect user data privacy and        provide secure communication.    -   Bi-directional authentication between the gateway and iConnect        server in order to prevent unauthorized spoofing and attacks.        Data sent from the iConnect server to the gateway application        (or vice versa) is digitally signed as an additional layer of        security. Digital signing provides both authentication and        validation that the data has not been altered in transit.    -   Camera SSL encapsulation because picture and video traffic        offered by off-the-shelf networked IP cameras is not secure when        traveling over the Internet. The gateway provides for 128-bit        SSL encapsulation of the user picture and video data sent over        the internet for complete user security and privacy.    -   802.11b/g/n with WPA-2 security to ensure that wireless camera        communications always takes place using the strongest available        protection.    -   A gateway-enabled device is assigned a unique activation key for        activation with an iConnect server. This ensures that only valid        gateway-enabled devices can be activated for use with the        specific instance of iConnect server in use. Attempts to        activate gateway-enabled devices by brute force are detected by        the Security Engine. Partners deploying gateway-enabled devices        have the knowledge that only a gateway with the correct serial        number and activation key can be activated for use with an        iConnect server. Stolen devices, devices attempting to        masquerade as gateway-enabled devices, and malicious outsiders        (or insiders as knowledgeable but nefarious customers) cannot        effect other customers' gateway-enabled devices.

As standards evolve, and new encryption and authentication methods areproven to be useful, and older mechanisms proven to be breakable, thesecurity manager can be upgraded “over the air” to provide new andbetter security for communications between the iConnect server and thegateway application, and locally at the premises to remove any risk ofeavesdropping on camera communications.

A Remote Firmware Download module 306 allows for seamless and secureupdates to the gateway firmware through the iControl MaintenanceApplication on the server 104, providing a transparent, hassle-freemechanism for the service provider to deploy new features and bug fixesto the installed user base. The firmware download mechanism is tolerantof connection loss, power interruption and user interventions (bothintentional and unintentional). Such robustness reduces down time andcustomer support issues. Gateway firmware can be remotely downloadeither for one gateway at a time, a group of gateways, or in batches.

The Automations engine 308 manages the user-defined rules of interactionbetween the different devices (e.g. when door opens turn on the light).Though the automation rules are programmed and reside at theportal/server level, they are cached at the gateway level in order toprovide short latency between device triggers and actions.

DeviceConnect 310 includes definitions of all supported devices (e.g.,cameras, security panels, sensors, etc.) using a standardized plug-inarchitecture. The DeviceConnect module 310 offers an interface that canbe used to quickly add support for any new device as well as enablinginteroperability between devices that use differenttechnologies/protocols. For common device types, pre-defined sub-moduleshave been defined, making supporting new devices of these types eveneasier. SensorConnect 312 is provided for adding new sensors,CameraConnect 316 for adding IP cameras, and PanelConnect 314 for addinghome security panels.

The Schedules engine 318 is responsible for executing the user definedschedules (e.g., take a picture every five minutes; every day at 8 amset temperature to 65 degrees Fahrenheit, etc.). Though the schedulesare programmed and reside at the iConnect server level they are sent tothe scheduler within the gateway application. The Schedules Engine 318then interfaces with SensorConnect 312 to ensure that scheduled eventsoccur at precisely the desired time.

The Device Management module 320 is in charge of all discovery,installation and configuration of both wired and wireless IP devices(e.g., cameras, etc.) coupled or connected to the system. Networked IPdevices, such as those used in the integrated security system, requireuser configuration of many IP and security parameters—to simplify theuser experience and reduce the customer support burden, the devicemanagement module of an embodiment handles the details of thisconfiguration. The device management module also manages the videorouting module described below.

The video routing engine 322 is responsible for delivering seamlessvideo streams to the user with zero-configuration. Through a multi-step,staged approach the video routing engine uses a combination of UPnPport-forwarding, relay server routing and STUN/TURN peer-to-peerrouting.

FIG. 4 is a block diagram of components of the gateway 102, under anembodiment. Depending on the specific set of functionality desired bythe service provider deploying the integrated security system service,the gateway 102 can use any of a number of processors 402, due to thesmall footprint of the gateway application firmware. In an embodiment,the gateway could include the Broadcom BCM5354 as the processor forexample. In addition, the gateway 102 includes memory (e.g., FLASH 404,RAM 406, etc.) and any number of input/output (I/O) ports 408.

Referring to the WAN portion 410 of the gateway 102, the gateway 102 ofan embodiment can communicate with the iConnect server using a number ofcommunication types and/or protocols, for example Broadband 412, GPRS414 and/or Public Switched Telephone Network (PTSN) 416 to name a few.In general, broadband communication 412 is the primary means ofconnection between the gateway 102 and the iConnect server 104 and theGPRS/CDMA 414 and/or PSTN 416 interfaces acts as backup for faulttolerance in case the user's broadband connection fails for whateverreason, but the embodiment is not so limited.

Referring to the LAN portion 420 of the gateway 102, various protocolsand physical transceivers can be used to communicate to off-the-shelfsensors and cameras. The gateway 102 is protocol-agnostic andtechnology-agnostic and as such can easily support almost any devicenetworking protocol. The gateway 102 can, for example, support GE andHoneywell security RF protocols 422, Z-Wave 424, serial (RS232 andRS485) 426 for direct connection to security panels as well as WiFi 428(802.11b/g) for communication to WiFi cameras.

The integrated security system includes couplings or connections among avariety of IP devices or components, and the device management module isin charge of the discovery, installation and configuration of the IPdevices coupled or connected to the system, as described above. Theintegrated security system of an embodiment uses a “sandbox” network todiscover and manage all IP devices coupled or connected as components ofthe system. The IP devices of an embodiment include wired devices,wireless devices, cameras, interactive touchscreens, and security panelsto name a few. These devices can be wired via ethernet cable or Wifidevices, all of which are secured within the sandbox network, asdescribed below. The “sandbox” network is described in detail below.

FIG. 5 is a block diagram 500 of network or premise device integrationwith a premise network 250, under an embodiment. In an embodiment,network devices 255-257 are coupled to the gateway 102 using a securenetwork coupling or connection such as SSL over an encrypted 802.11 link(utilizing for example WPA-2 security for the wireless encryption). Thenetwork coupling or connection between the gateway 102 and the networkdevices 255-257 is a private coupling or connection in that it issegregated from any other network couplings or connections. The gateway102 is coupled to the premise router/firewall 252 via a coupling with apremise LAN 250. The premise router/firewall 252 is coupled to abroadband modem 251, and the broadband modem 251 is coupled to a WAN 200or other network outside the premise. The gateway 102 thus enables orforms a separate wireless network, or sub-network, that includes somenumber of devices and is coupled or connected to the LAN 250 of the hostpremises. The gateway sub-network can include, but is not limited to,any number of other devices like WiFi IP cameras, security panels (e.g.,IP-enabled), and security touchscreens, to name a few. The gateway 102manages or controls the sub-network separately from the LAN 250 andtransfers data and information between components of the sub-network andthe LAN 250/WAN 200, but is not so limited. Additionally, other networkdevices 254 can be coupled to the LAN 250 without being coupled to thegateway 102.

FIG. 6 is a block diagram 600 of network or premise device integrationwith a premise network 250, under an alternative embodiment. The networkor premise devices 255-257 are coupled to the gateway 102. The networkcoupling or connection between the gateway 102 and the network devices255-257 is a private coupling or connection in that it is segregatedfrom any other network couplings or connections. The gateway 102 iscoupled or connected between the premise router/firewall 252 and thebroadband modem 251. The broadband modem 251 is coupled to a WAN 200 orother network outside the premise, while the premise router/firewall 252is coupled to a premise LAN 250. As a result of its location between thebroadband modem 251 and the premise router/firewall 252, the gateway 102can be configured or function as the premise router routing specifieddata between the outside network (e.g., WAN 200) and the premiserouter/firewall 252 of the LAN 250. As described above, the gateway 102in this configuration enables or forms a separate wireless network, orsub-network, that includes the network or premise devices 255-257 and iscoupled or connected between the LAN 250 of the host premises and theWAN 200. The gateway sub-network can include, but is not limited to, anynumber of network or premise devices 255-257 like WiFi IP cameras,security panels (e.g., IP-enabled), and security touchscreens, to name afew. The gateway 102 manages or controls the sub-network separately fromthe LAN 250 and transfers data and information between components of thesub-network and the LAN 250/WAN 200, but is not so limited.Additionally, other network devices 254 can be coupled to the LAN 250without being coupled to the gateway 102.

The examples described above with reference to FIGS. 5 and 6 arepresented only as examples of IP device integration. The integratedsecurity system is not limited to the type, number and/or combination ofIP devices shown and described in these examples, and any type, numberand/or combination of IP devices is contemplated within the scope ofthis disclosure as capable of being integrated with the premise network.

The integrated security system of an embodiment includes a touchscreen(also referred to as the iControl touchscreen or integrated securitysystem touchscreen), as described above, which provides core securitykeypad functionality, content management and presentation, and embeddedsystems design. The networked security touchscreen system of anembodiment enables a consumer or security provider to easily andautomatically install, configure and manage the security system andtouchscreen located at a customer premise. Using this system thecustomer may access and control the local security system, local IPdevices such as cameras, local sensors and control devices (such aslighting controls or pipe freeze sensors), as well as the local securitysystem panel and associated security sensors (such as door/window,motion, and smoke detectors). The customer premise may be a home,business, and/or other location equipped with a wired or wirelessbroadband IP connection.

The system of an embodiment includes a touchscreen with a configurablesoftware user interface and/or a gateway device (e.g., iHub) thatcouples or connects to a premise security panel through a wired orwireless connection, and a remote server that provides access to contentand information from the premises devices to a user when they are remotefrom the home. The touchscreen supports broadband and/or WAN wirelessconnectivity. In this embodiment, the touchscreen incorporates an IPbroadband connection (e.g., Wifi radio, Ethernet port, etc.), and/or acellular radio (e.g., GPRS/GSM, CDMA, WiMax, etc.). The touchscreendescribed herein can be used as one or more of a security systeminterface panel and a network user interface (UI) that provides aninterface to interact with a network (e.g., LAN, WAN, internet, etc.).

The touchscreen of an embodiment provides an integrated touchscreen andsecurity panel as an all-in-one device. Once integrated using thetouchscreen, the touchscreen and a security panel of a premise securitysystem become physically co-located in one device, and the functionalityof both may even be co-resident on the same CPU and memory (though thisis not required).

The touchscreen of an embodiment also provides an integrated IP videoand touchscreen UI. As such, the touchscreen supports one or morestandard video CODECs/players (e.g., H.264, Flash Video, MOV, MPEG4,M-JPEG, etc.). The touchscreen UI then provides a mechanism (such as acamera or video widget) to play video. In an embodiment the video isstreamed live from an IP video camera. In other embodiments the videocomprises video clips or photos sent from an IP camera or from a remotelocation.

The touchscreen of an embodiment provides a configurable user interfacesystem that includes a configuration supporting use as a securitytouchscreen. In this embodiment, the touchscreen utilizes a modular userinterface that allows components to be modified easily by a serviceprovider, an installer, or even the end user. Examples of such a modularapproach include using Flash widgets, HTML-based widgets, or otherdownloadable code modules such that the user interface of thetouchscreen can be updated and modified while the application isrunning. In an embodiment the touchscreen user interface modules can bedownloaded over the internet. For example, a new security configurationwidget can be downloaded from a standard web server, and the touchscreenthen loads such configuration app into memory, and inserts it in placeof the old security configuration widget. The touchscreen of anembodiment is configured to provide a self-install user interface.

Embodiments of the networked security touchscreen system describedherein include a touchscreen device with a user interface that includesa security toolbar providing one or more functions including arm,disarm, panic, medic, and alert. The touchscreen therefore includes atleast one screen having a separate region of the screen dedicated to asecurity toolbar. The security toolbar of an embodiment is present inthe dedicated region at all times that the screen is active.

The touchscreen of an embodiment includes a home screen having aseparate region of the screen allocated to managing home-basedfunctions. The home-based functions of an embodiment include managing,viewing, and/or controlling IP video cameras. In this embodiment,regions of the home screen are allocated in the form of widget icons;these widget icons (e.g. for cameras, thermostats, lighting, etc)provide functionality for managing home systems. So, for example, adisplayed camera icon, when selected, launches a Camera Widget, and theCamera widget in turn provides access to video from one or more cameras,as well as providing the user with relevant camera controls (take apicture, focus the camera, etc.)

The touchscreen of an embodiment includes a home screen having aseparate region of the screen allocated to managing, viewing, and/orcontrolling internet-based content or applications. For example, theWidget Manager UI presents a region of the home screen (up to andincluding the entire home screen) where internet widgets icons such asweather, sports, etc. may be accessed). Each of these icons may beselected to launch their respective content services.

The touchscreen of an embodiment is integrated into a premise networkusing the gateway, as described above. The gateway as described hereinfunctions to enable a separate wireless network, or sub-network, that iscoupled, connected, or integrated with another network (e.g., WAN, LANof the host premises, etc.). The sub-network enabled by the gatewayoptimizes the installation process for IP devices, like the touchscreen,that couple or connect to the sub-network by segregating these IPdevices from other such devices on the network. This segregation of theIP devices of the sub-network further enables separate security andprivacy policies to be implemented for these IP devices so that, wherethe IP devices are dedicated to specific functions (e.g., security), thesecurity and privacy policies can be tailored specifically for thespecific functions. Furthermore, the gateway and the sub-network itforms enables the segregation of data traffic, resulting in faster andmore efficient data flow between components of the host network,components of the sub-network, and between components of the sub-networkand components of the network.

The touchscreen of an embodiment includes a core functional embeddedsystem that includes an embedded operating system, required hardwaredrivers, and an open system interface to name a few. The core functionalembedded system can be provided by or as a component of a conventionalsecurity system (e.g., security system available from GE Security).These core functional units are used with components of the integratedsecurity system as described herein. Note that portions of thetouchscreen description below may include reference to a host premisesecurity system (e.g., GE security system), but these references areincluded only as an example and do not limit the touchscreen tointegration with any particular security system.

As an example, regarding the core functional embedded system, a reducedmemory footprint version of embedded Linux forms the core operatingsystem in an embodiment, and provides basic TCP/IP stack and memorymanagement functions, along with a basic set of low-level graphicsprimitives. A set of device drivers is also provided or included thatoffer low-level hardware and network interfaces. In addition to thestandard drivers, an interface to the RS 485 bus is included thatcouples or connects to the security system panel (e.g., GE Concordpanel). The interface may, for example, implement the Superbus 2000protocol, which can then be utilized by the more comprehensivetransaction-level security functions implemented in PanelConnecttechnology (e.g SetAlarmLevel (int level, int partition, char*accessCode)). Power control drivers are also provided.

FIG. 7 is a block diagram of a touchscreen 700 of the integratedsecurity system, under an embodiment. The touchscreen 700 generallyincludes an application/presentation layer 702 with a residentapplication 704, and a core engine 706. The touchscreen 700 alsoincludes one or more of the following, but is not so limited:applications of premium services 710, widgets 712, a caching proxy 714,network security 716, network interface 718, security object 720,applications supporting devices 722, PanelConnect API 724, a gatewayinterface 726, and one or more ports 728.

More specifically, the touchscreen, when configured as a home securitydevice, includes but is not limited to the following application orsoftware modules: RS 485 and/or RS-232 bus security protocols toconventional home security system panel (e.g., GE Concord panel);functional home security classes and interfaces (e.g. Panel ARM state,Sensor status, etc.); Application/Presentation layer or engine; ResidentApplication; Consumer Home Security Application; installer home securityapplication; core engine; and System bootloader/Software Updater. Thecore Application engine and system bootloader can also be used tosupport other advanced content and applications. This provides aseamless interaction between the premise security application and otheroptional services such as weather widgets or IP cameras.

An alternative configuration of the touchscreen includes a firstApplication engine for premise security and a second Application enginefor all other applications. The integrated security system applicationengine supports content standards such as HTML, XML, Flash, etc. andenables a rich consumer experience for all ‘widgets’, whethersecurity-based or not. The touchscreen thus provides service providersthe ability to use web content creation and management tools to buildand download any ‘widgets’ regardless of their functionality.

As discussed above, although the Security Applications have specificlow-level functional requirements in order to interface with the premisesecurity system, these applications make use of the same fundamentalapplication facilities as any other ‘widget’, application facilitiesthat include graphical layout, interactivity, application handoff,screen management, and network interfaces, to name a few.

Content management in the touchscreen provides the ability to leverageconventional web development tools, performance optimized for anembedded system, service provider control of accessible content, contentreliability in a consumer device, and consistency between ‘widgets’ andseamless widget operational environment. In an embodiment of theintegrated security system, widgets are created by web developers andhosted on the integrated security system Content Manager (and stored inthe Content Store database). In this embodiment the server componentcaches the widgets and offers them to consumers through the web-basedintegrated security system provisioning system. The servers interactwith the advanced touchscreen using HTTPS interfaces controlled by thecore engine and dynamically download widgets and updates as needed to becached on the touchscreen. In other embodiments widgets can be accesseddirectly over a network such as the Internet without needing to gothrough the iControl Content Manager

Referring to FIG. 7, the touchscreen system is built on a tieredarchitecture, with defined interfaces between theApplication/Presentation Layer (the Application Engine) on the top, theCore Engine in the middle, and the security panel and gateway APIs atthe lower level. The architecture is configured to provide maximumflexibility and ease of maintenance.

The application engine of the touchscreen provides the presentation andinteractivity capabilities for all applications (widgets) that run onthe touchscreen, including both core security function widgets and thirdparty content widgets. FIG. 8 is an example screenshot 800 of anetworked security touchscreen, under an embodiment. This examplescreenshot 800 includes three interfaces or user interface (UI)components 802-806, but is not so limited. A first UI 802 of thetouchscreen includes icons by which a user controls or accessesfunctions and/or components of the security system (e.g., “Main”,“Panic”, “Medic”, “Fire”, state of the premise alarm system (e.g.,disarmed, armed, etc.), etc.); the first UI 802, which is also referredto herein as a security interface, is always presented on thetouchscreen. A second UI 804 of the touchscreen includes icons by whicha user selects or interacts with services and other network content(e.g., clock, calendar, weather, stocks, news, sports, photos, maps,music, etc.) that is accessible via the touchscreen. The second UI 804is also referred to herein as a network interface or content interface.A third UI 806 of the touchscreen includes icons by which a user selectsor interacts with additional services or componets (e.g., intercomcontrol, security, cameras coupled to the system in particular regions(e.g., front door, baby, etc.) available via the touchscreen.

A component of the application engine is the Presentation Engine, whichincludes a set of libraries that implement the standards-based widgetcontent (e.g., XML, HTML, JavaScript, Flash) layout and interactivity.This engine provides the widget with interfaces to dynamically load bothgraphics and application logic from third parties, support high leveldata description language as well as standard graphic formats. The setof web content-based functionality available to a widget developer isextended by specific touchscreen functions implemented as local webservices by the Core Engine.

The resident application of the touchscreen is the master service thatcontrols the interaction of all widgets in the system, and enforces thebusiness and security rules required by the service provider. Forexample, the resident application determines the priority of widgets,thereby enabling a home security widget to override resource requestsfrom a less critical widget (e.g. a weather widget). The residentapplication also monitors widget behavior, and responds to client orserver requests for cache updates.

The core engine of the touchscreen manages interaction with othercomponents of the integrated security system, and provides an interfacethrough which the resident application and authorized widgets can getinformation about the home security system, set alarms, install sensors,etc. At the lower level, the Core Engine's main interactions are throughthe PanelConnect API, which handles all communication with the securitypanel, and the gateway Interface, which handles communication with thegateway. In an embodiment, both the iHub Interface and PanelConnect APIare resident and operating on the touchscreen. In another embodiment,the PanelConnect API runs on the gateway or other device that providessecurity system interaction and is accessed by the touchscreen through aweb services interface.

The Core Engine also handles application and service level persistentand cached memory functions, as well as the dynamic provisioning ofcontent and widgets, including but not limited to: flash memorymanagement, local widget and content caching, widget version management(download, cache flush new/old content versions), as well as the cachingand synchronization of user preferences. As a portion of these servicesthe Core engine incorporates the bootloader functionality that isresponsible for maintaining a consistent software image on thetouchscreen, and acts as the client agent for all software updates. Thebootloader is configured to ensure full update redundancy so thatunsuccessful downloads cannot corrupt the integrated security system.

Video management is provided as a set of web services by the CoreEngine. Video management includes the retrieval and playback of localvideo feeds as well as remote control and management of cameras (allthrough iControl CameraConnect technology).

Both the high level application layer and the mid-level core engine ofthe touchscreen can make calls to the network. Any call to the networkmade by the application layer is automatically handed off to a localcaching proxy, which determines whether the request should be handledlocally. Many of the requests from the application layer are webservices API requests, although such requests could be satisfied by theiControl servers, they are handled directly by the touchscreen and thegateway. Requests that get through the caching proxy are checked againsta white list of acceptable sites, and, if they match, are sent offthrough the network interface to the gateway. Included in the NetworkSubsystem is a set of network services including HTTP, HTTPS, andserver-level authentication functions to manage the secure client-serverinterface. Storage and management of certificates is incorporated as apart of the network services layer.

Server components of the integrated security system servers supportinteractive content services on the touchscreen. These server componentsinclude, but are not limited to the content manager, registry manager,network manager, and global registry, each of which is described herein.

The Content Manager oversees aspects of handling widget data and rawcontent on the touchscreen. Once created and validated by the serviceprovider, widgets are ‘ingested’ to the Content Manager, and then becomeavailable as downloadable services through the integrated securitysystem Content Management APIs. The Content manager maintains versionsand timestamp information, and connects to the raw data contained in thebackend Content Store database. When a widget is updated (or new contentbecomes available) all clients registering interest in a widget aresystematically updated as needed (a process that can be configured at anaccount, locale, or system-wide level).

The Registry Manager handles user data, and provisioning accounts,including information about widgets the user has decided to install, andthe user preferences for these widgets.

The Network Manager handles getting and setting state for all devices onthe integrated security system network (e.g., sensors, panels, cameras,etc.). The Network manager synchronizes with the gateway, the advancedtouchscreen, and the subscriber database.

The Global Registry is a primary starting point server for all clientservices, and is a logical referral service that abstracts specificserver locations/addresses from clients (touchscreen, gateway 102,desktop widgets, etc.). This approach enables easy scaling/migration ofserver farms.

The touchscreen of an embodiment operates wirelessly with a premisesecurity system. The touchscreen of an embodiment incorporates an RFtransceiver component that either communicates directly with the sensorsand/or security panel over the panel's proprietary RF frequency, or thetouchscreen communicates wirelessly to the gateway over 802.11,Ethernet, or other IP-based communications channel, as described indetail herein. In the latter case the gateway implements thePanelConnect interface and communicates directly to the security paneland/or sensors over wireless or wired networks as described in detailabove.

The touchscreen of an embodiment is configured to operate with multiplesecurity systems through the use of an abstracted security systeminterface. In this embodiment, the PanelConnect API can be configured tosupport a plurality of proprietary security system interfaces, eithersimultaneously or individually as described herein. In one embodiment ofthis approach, the touchscreen incorporates multiple physical interfacesto security panels (e.g. GE Security RS-485, Honeywell RF, etc.) inaddition to the PanelConnect API implemented to support multiplesecurity interfaces. The change needed to support this in PanelConnectis a configuration parameter specifying the panel type connection thatis being utilized.

So for example, the setARMState( ) function is called with an additionalparameter (e.g., Armstate=setARMState(type=“ARM STAY|ARM AWAY|DISARM”,Parameters=“ExitDelay=30|Lights=OFF”, panelType=“GE Concord4 RS485”)).The ‘panelType’ parameter is used by the setARMState function (and inpractice by all of the PanelConnect functions) to select an algorithmappropriate to the specific panel out of a plurality of alogorithms.

The touchscreen of an embodiment is self-installable. Consequently, thetouchscreen provides a ‘wizard’ approach similar to that used intraditional computer installations (e.g. InstallShield). The wizard canbe resident on the touchscreen, accessible through a web interface, orboth. In one embodiment of a touchscreen self-installation process, theservice provider can associate devices (sensors, touchscreens, securitypanels, lighting controls, etc.) remotely using a web-basedadministrator interface.

The touchscreen of an embodiment includes a battery backup system for asecurity touchscreen. The touchscreen incorporates a standard Li-ion orother battery and charging circuitry to allow continued operation in theevent of a power outage. In an embodiment the battery is physicallylocated and connected within the touchscreen enclosure. In anotherembodiment the battery is located as a part of the power transformer, orin between the power transformer and the touchscreen.

The example configurations of the integrated security system describedabove with reference to FIGS. 5 and 6 include a gateway that is aseparate device, and the touchscreen couples to the gateway. However, inan alternative embodiment, the gateway device and its functionality canbe incorporated into the touchscreen so that the device managementmodule, which is now a component of or included in the touchscreen, isin charge of the discovery, installation and configuration of the IPdevices coupled or connected to the system, as described above. Theintegrated security system with the integrated touchscreen/gateway usesthe same “sandbox” network to discover and manage all IP devices coupledor connected as components of the system.

The touchscreen of this alternative embodiment integrates the componentsof the gateway with the components of the touchscreen as describedherein. More specifically, the touchscreen of this alternativeembodiment includes software or applications described above withreference to FIG. 3. In this alternative embodiment, the touchscreenincludes the gateway application layer 302 as the main program thatorchestrates the operations performed by the gateway. A Security Engine304 of the touchscreen provides robust protection against intentionaland unintentional intrusion into the integrated security system networkfrom the outside world (both from inside the premises as well as fromthe WAN). The Security Engine 304 of an embodiment comprises one or moresub-modules or components that perform functions including, but notlimited to, the following:

-   -   Encryption including 128-bit SSL encryption for gateway and        iConnect server communication to protect user data privacy and        provide secure communication.    -   Bi-directional authentication between the touchscreen and        iConnect server in order to prevent unauthorized spoofing and        attacks. Data sent from the iConnect server to the gateway        application (or vice versa) is digitally signed as an additional        layer of security. Digital signing provides both authentication        and validation that the data has not been altered in transit.    -   Camera SSL encapsulation because picture and video traffic        offered by off-the-shelf networked IP cameras is not secure when        traveling over the Internet. The touchscreen provides for        128-bit SSL encapsulation of the user picture and video data        sent over the internet for complete user security and privacy.    -   802.11b/g/n with WPA-2 security to ensure that wireless camera        communications always takes place using the strongest available        protection.    -   A touchscreen-enabled device is assigned a unique activation key        for activation with an iConnect server. This ensures that only        valid gateway-enabled devices can be activated for use with the        specific instance of iConnect server in use. Attempts to        activate gateway-enabled devices by brute force are detected by        the Security Engine. Partners deploying touchscreen-enabled        devices have the knowledge that only a gateway with the correct        serial number and activation key can be activated for use with        an iConnect server. Stolen devices, devices attempting to        masquerade as gateway-enabled devices, and malicious outsiders        (or insiders as knowledgeable but nefarious customers) cannot        effect other customers' gateway-enabled devices.

As standards evolve, and new encryption and authentication methods areproven to be useful, and older mechanisms proven to be breakable, thesecurity manager can be upgraded “over the air” to provide new andbetter security for communications between the iConnect server and thegateway application, and locally at the premises to remove any risk ofeavesdropping on camera communications.

A Remote Firmware Download module 306 of the touchscreen allows forseamless and secure updates to the gateway firmware through the iControlMaintenance Application on the server 104, providing a transparent,hassle-free mechanism for the service provider to deploy new featuresand bug fixes to the installed user base. The firmware downloadmechanism is tolerant of connection loss, power interruption and userinterventions (both intentional and unintentional). Such robustnessreduces down time and customer support issues. Touchscreen firmware canbe remotely download either for one touchscreen at a time, a group oftouchscreen, or in batches.

The Automations engine 308 of the touchscreen manages the user-definedrules of interaction between the different devices (e.g. when door opensturn on the light). Though the automation rules are programmed andreside at the portal/server level, they are cached at the gateway levelin order to provide short latency between device triggers and actions.

DeviceConnect 310 of the touchscreen touchscreen includes definitions ofall supported devices (e.g., cameras, security panels, sensors, etc.)using a standardized plug-in architecture. The DeviceConnect module 310offers an interface that can be used to quickly add support for any newdevice as well as enabling interoperability between devices that usedifferent technologies/protocols. For common device types, pre-definedsub-modules have been defined, making supporting new devices of thesetypes even easier. SensorConnect 312 is provided for adding new sensors,CameraConnect 316 for adding IP cameras, and PanelConnect 314 for addinghome security panels.

The Schedules engine 318 of the touchscreen is responsible for executingthe user defined schedules (e.g., take a picture every five minutes;every day at 8 am set temperature to 65 degrees Fahrenheit, etc.).Though the schedules are programmed and reside at the iConnect serverlevel they are sent to the scheduler within the gateway application ofthe touchscreen. The Schedules Engine 318 then interfaces withSensorConnect 312 to ensure that scheduled events occur at precisely thedesired time.

The Device Management module 320 of the touchscreen is in charge of alldiscovery, installation and configuration of both wired and wireless IPdevices (e.g., cameras, etc.) coupled or connected to the system.Networked IP devices, such as those used in the integrated securitysystem, require user configuration of many IP and security parameters,and the device management module of an embodiment handles the details ofthis configuration. The device management module also manages the videorouting module described below.

The video routing engine 322 of the touchscreen is responsible fordelivering seamless video streams to the user with zero-configuration.Through a multi-step, staged approach the video routing engine uses acombination of UPnP port-forwarding, relay server routing and STUN/TURNpeer-to-peer routing. The video routing engine is described in detail inthe Related Applications.

FIG. 9 is a block diagram 900 of network or premise device integrationwith a premise network 250, under an embodiment. In an embodiment,network devices 255, 256, 957 are coupled to the touchscreen 902 using asecure network connection such as SSL over an encrypted 802.11 link(utilizing for example WPA-2 security for the wireless encryption), andthe touchscreen 902 coupled to the premise router/firewall 252 via acoupling with a premise LAN 250. The premise router/firewall 252 iscoupled to a broadband modem 251, and the broadband modem 251 is coupledto a WAN 200 or other network outside the premise. The touchscreen 902thus enables or forms a separate wireless network, or sub-network, thatincludes some number of devices and is coupled or connected to the LAN250 of the host premises. The touchscreen sub-network can include, butis not limited to, any number of other devices like WiFi IP cameras,security panels (e.g., IP-enabled), and IP devices, to name a few. Thetouchscreen 902 manages or controls the sub-network separately from theLAN 250 and transfers data and information between components of thesub-network and the LAN 250/WAN 200, but is not so limited.Additionally, other network devices 254 can be coupled to the LAN 250without being coupled to the touchscreen 902.

FIG. 10 is a block diagram 1000 of network or premise device integrationwith a premise network 250, under an alternative embodiment. The networkor premise devices 255, 256, 1057 are coupled to the touchscreen 1002,and the touchscreen 1002 is coupled or connected between the premiserouter/firewall 252 and the broadband modem 251. The broadband modem 251is coupled to a WAN 200 or other network outside the premise, while thepremise router/firewall 252 is coupled to a premise LAN 250. As a resultof its location between the broadband modem 251 and the premiserouter/firewall 252, the touchscreen 1002 can be configured or functionas the premise router routing specified data between the outside network(e.g., WAN 200) and the premise router/firewall 252 of the LAN 250. Asdescribed above, the touchscreen 1002 in this configuration enables orforms a separate wireless network, or sub-network, that includes thenetwork or premise devices 255, 156, 1057 and is coupled or connectedbetween the LAN 250 of the host premises and the WAN 200. Thetouchscreen sub-network can include, but is not limited to, any numberof network or premise devices 255, 256, 1057 like WiFi IP cameras,security panels (e.g., IP-enabled), and security touchscreens, to name afew. The touchscreen 1002 manages or controls the sub-network separatelyfrom the LAN 250 and transfers data and information between componentsof the sub-network and the LAN 250/WAN 200, but is not so limited.Additionally, other network devices 254 can be coupled to the LAN 250without being coupled to the touchscreen 1002.

The gateway of an embodiment, whether a stand-along component orintegrated with a touchscreen, enables couplings or connections and thusthe flow or integration of information between various components of thehost premises and various types and/or combinations of IP devices, wherethe components of the host premises include a network (e.g., LAN) and/ora security system or subsystem to name a few. Consequently, the gatewaycontrols the association between and the flow of information or databetween the components of the host premises. For example, the gateway ofan embodiment forms a sub-network coupled to another network (e.g., WAN,LAN, etc.), with the sub-network including IP devices. The gatewayfurther enables the association of the IP devices of the sub-networkwith appropriate systems on the premises (e.g., security system, etc.).Therefore, for example, the gateway can form a sub-network of IP devicesconfigured for security functions, and associate the sub-network onlywith the premises security system, thereby segregating the IP devicesdedicated to security from other IP devices that may be coupled toanother network on the premises.

The gateway of an embodiment, as described herein, enables couplings orconnections and thus the flow of information between various componentsof the host premises and various types and/or combinations of IPdevices, where the components of the host premises include a network, asecurity system or subsystem to name a few. Consequently, the gatewaycontrols the association between and the flow of information or databetween the components of the host premises. For example, the gateway ofan embodiment forms a sub-network coupled to another network (e.g., WAN,LAN, etc.), with the sub-network including IP devices. The gatewayfurther enables the association of the IP devices of the sub-networkwith appropriate systems on the premises (e.g., security system, etc.).Therefore, for example, the gateway can form a sub-network of IP devicesconfigured for security functions, and associate the sub-network onlywith the premises security system, thereby segregating the IP devicesdedicated to security from other IP devices that may be coupled toanother network on the premises.

FIG. 11 is a flow diagram for a method 1100 of forming a securitynetwork including integrated security system components, under anembodiment. Generally, the method comprises coupling 1102 a gatewaycomprising a connection management component to a local area network ina first location and a security server in a second location. The methodcomprises forming 1104 a security network by automatically establishinga wireless coupling between the gateway and a security system using theconnection management component. The security system of an embodimentcomprises security system components located at the first location. Themethod comprises integrating 1106 communications and functions of thesecurity system components into the security network via the wirelesscoupling.

FIG. 12 is a flow diagram for a method 1200 of forming a securitynetwork including integrated security system components and networkdevices, under an embodiment. Generally, the method comprises coupling1202 a gateway to a local area network located in a first location and asecurity server in a second location. The method comprises automaticallyestablishing 1204 communications between the gateway and security systemcomponents at the first location, the security system including thesecurity system components. The method comprises automaticallyestablishing 1206 communications between the gateway and premise devicesat the first location. The method comprises forming 1208 a securitynetwork by electronically integrating, via the gateway, communicationsand functions of the premise devices and the security system components.

In an example embodiment, FIG. 13 is a flow diagram 1300 for integrationor installation of an IP device into a private network environment,under an embodiment. The IP device includes any IP-capable device that,for example, includes the touchscreen of an embodiment. The variables ofan embodiment set at time of installation include, but are not limitedto, one or more of a private SSID/Password, a gateway identifier, asecurity panel identifier, a user account TS, and a Central MonitoringStation account identification.

An embodiment of the IP device discovery and management begins with auser or installer activating 1302 the gateway and initiating 1304 theinstall mode of the system. This places the gateway in an install mode.Once in install mode, the gateway shifts to a default (Install) Wificonfiguration. This setting will match the default setting for otherintegrated security system-enabled devices that have been pre-configuredto work with the integrated security system. The gateway will then beginto provide 1306 DHCP addresses for these IP devices. Once the deviceshave acquired a new DHCP address from the gateway, those devices areavailable for configuration into a new secured Wifi network setting.

The user or installer of the system selects 1308 all devices that havebeen identified as available for inclusion into the integrated securitysystem. The user may select these devices by their unique IDs via a webpage, Touchscreen, or other client interface. The gateway provides 1310data as appropriate to the devices. Once selected, the devices areconfigured 1312 with appropriate secured Wifi settings, including SSIDand WPA/WPA-2 keys that are used once the gateway switches back to thesecured sandbox configuration from the “Install” settings. Othersettings are also configured as appropriate for that type of device.Once all devices have been configured, the user is notified and the usercan exit install mode. At this point all devices will have beenregistered 1314 with the integrated security system servers.

The installer switches 1316 the gateway to an operational mode, and thegateway instructs or directs 1318 all newly configured devices to switchto the “secured” Wifi sandbox settings. The gateway then switches 1320to the “secured” Wifi settings. Once the devices identify that thegateway is active on the “secured” network, they request new DHCPaddresses from the gateway which, in response, provides 1322 the newaddresses. The devices with the new addresses are then operational 1324on the secured network.

In order to ensure the highest level of security on the secured network,the gateway can create or generate a dynamic network securityconfiguration based on the unique ID and private key in the gateway,coupled with a randomizing factor that can be based on online time orother inputs. This guarantees the uniqueness of the gateway securednetwork configuration.

To enable the highest level of performance, the gateway analyzes the RFspectrum of the 802.11x network and determines which frequencyband/channel it should select to run.

An alternative embodiment of the camera/IP device management processleverages the local ethernet connection of the sandbox network on thegateway. This alternative process is similar to the Wifi discoveryembodiment described above, except the user connects the targeted deviceto the ethernet port of the sandbox network to begin the process. Thisalternative embodiment accommodates devices that have not beenpre-configured with the default “Install” configuration for theintegrated security system.

This alternative embodiment of the IP device discovery and managementbegins with the user/installer placing the system into install mode. Theuser is instructed to attach an IP device to be installed to the sandboxEthernet port of the gateway. The IP device requests a DHCP address fromthe gateway which, in response to the request, provides the address. Theuser is presented the device and is asked if he/she wants to install thedevice. If yes, the system configures the device with the secured Wifisettings and other device-specific settings (e.g., camera settings forvideo length, image quality etc.). The user is next instructed todisconnect the device from the ethernet port. The device is nowavailable for use on the secured sandbox network.

FIG. 14 is a block diagram showing communications among integrated IPdevices of the private network environment, under an embodiment. The IPdevices of this example include a security touchscreen 1403, gateway1402 (e.g., “iHub”), and security panel (e.g., “Security Panel 1”,“Security Panel 2”, “Security Panel n”), but the embodiment is not solimited. In alternative embodiments any number and/or combination ofthese three primary component types may be combined with othercomponents including IP devices and/or security system components. Forexample, a single device that comprises an integrated gateway,touchscreen, and security panel is merely another embodiment of theintegrated security system described herein. The description thatfollows includes an example configuration that includes a touchscreenhosting particular applications. However, the embodiment is not limitedto the touchscreen hosting these applications, and the touchscreenshould be thought of as representing any IP device.

Referring to FIG. 14, the touchscreen 1403 incorporates an application1410 that is implemented as computer code resident on the touchscreenoperating system, or as a web-based application running in a browser, oras another type of scripted application (e.g., Flash, Java, VisualBasic, etc.). The touchscreen core application 1410 represents thisapplication, providing user interface and logic for the end user tomanage their security system or to gain access to networked informationor content (Widgets). The touchscreen core application 1410 in turnaccesses a library or libraries of functions to control the localhardware (e.g. screen display, sound, LEDs, memory, etc.) as well asspecialized librarie(s) to couple or connect to the security system.

In an embodiment of this security system connection, the touchscreen1403 communicates to the gateway 1402, and has no direct communicationwith the security panel. In this embodiment, the touchscreen coreapplication 1410 accesses the remote service APIs 1412 which providesecurity system functionality (e.g. ARM/DISARM panel, sensor state,get/set panel configuration parameters, initiate or get alarm events,etc.). In an embodiment, the remote service APIs 1412 implement one ormore of the following functions, but the embodiment is not so limited:Armstate=setARMState(type=“ARM STAY|ARM AWAY|DISARM”,Parameters=“ExitDelay=30|Lights=OFF”);sensorState=getSensors(type=“ALL|SensorName|SensorNameList”);result=setSensorState(SensorName, parameters=“Option1, Options2, . . .Option n”); interruptHandler=SensorEvent( ) and,interruptHandler=alarmEvent( ).

Functions of the remote service APIs 1412 of an embodiment use a remotePanelConnect API 1424 which which resides in memory on the gateway 1402.The touchscreen 1403 communicates with the gateway 1402 through asuitable network interface such as an Ethernet or 802.11 RF connection,for example. The remote PanelConnect API 1424 provides the underlyingSecurity System Interfaces 1426 used to communicate with and control oneor more types of security panel via wired link 1430 and/or RF link 3.The PanelConnect API 1224 provides responses and input to the remoteservices APIs 1426, and in turn translates function calls and data toand from the specific protocols and functions supported by a specificimplementation of a Security Panel (e.g. a GE Security Simon XT orHoneywell Vista 20P). In an embodiment, the PanelConnect API 1224 uses a345 MHz RF transceiver or receiver hardware/firmware module tocommunicate wirelessly to the security panel and directly to a set of345 MHz RF-enabled sensors and devices, but the embodiment is not solimited.

The gateway of an alternative embodiment communicates over a wiredphysical coupling or connection to the security panel using the panel'sspecific wired hardware (bus) interface and the panel's bus-levelprotocol.

In an alternative embodiment, the Touchscreen 1403 implements the samePanelConnect API 1414 locally on the Touchscreen 1403, communicatingdirectly with the Security Panel 2 and/or Sensors 2 over the proprietaryRF link or over a wired link for that system. In this embodiment theTouchscreen 1403, instead of the gateway 1402, incorporates the 345 MHzRF transceiver to communicate directly with Security Panel 2 or Sensors2 over the RF link 2. In the case of a wired link the Touchscreen 1403incorporates the real-time hardware (e.g. a PIC chip and RS232-variantserial link) to physically connect to and satisfy the specific bus-leveltiming requirements of the SecurityPanel2.

In yet another alternative embodiment, either the gateway 1402 or theTouchscreen 1403 implements the remote service APIs. This embodimentincludes a Cricket device (“Cricket”) which comprises but is not limitedto the following components: a processor (suitable for handling 802.11protocols and processing, as well as the bus timing requirements ofSecurityPanel1); an 802.11 (WiFi) client IP interface chip; and, aserial bus interface chip that implements variants of RS232 or RS485,depending on the specific Security Panel.

The Cricket also implements the full PanelConnect APIs such that it canperform the same functions as the case where the gateway implements thePanelConnect APIs. In this embodiment, the touchscreen core application1410 calls functions in the remote service APIs 1412 (such assetArmState( ). These functions in turn couple or connect to the remoteCricket through a standard IP connection (“Cricket IP Link”) (e.g.,Ethernet, Homeplug, the gateway's proprietary Wifi network, etc.). TheCricket in turn implements the PanelConnect API, which responds to therequest from the touchscreen core application, and performs theappropriate function using the proprietary panel interface. Thisinterface uses either the wireless or wired proprietary protocol for thespecific security panel and/or sensors.

FIG. 15 is a flow diagram of a method of integrating an external controland management application system with an existing security system,under an embodiment. Operations begin when the system is powered on1510, involving at a minimum the power-on of the gateway device, andoptionally the power-on of the connection between the gateway device andthe remote servers. The gateway device initiates 1520 a software and RFsequence to locate the extant security system. The gateway and installerinitiate and complete 1530 a sequence to ‘learn’ the gateway into thesecurity system as a valid and authorized control device. The gatewayinitiates 1540 another software and RF sequence of instructions todiscover and learn the existence and capabilities of existing RF deviceswithin the extant security system, and store this information in thesystem. These operations under the system of an embodiment are describedin further detail below.

Unlike conventional systems that extend an existing security system, thesystem of an embodiment operates utilizing the proprietary wirelessprotocols of the security system manufacturer. In one illustrativeembodiment, the gateway is an embedded computer with an IP LAN and WANconnection and a plurality of RF transceivers and software protocolmodules capable of communicating with a plurality of security systemseach with a potentially different RF and software protocol interface.After the gateway has completed the discovery and learning 1540 ofsensors and has been integrated 1550 as a virtual control device in theextant security system, the system becomes operational. Thus, thesecurity system and associated sensors are presented 1550 as accessibledevices to a potential plurality of user interface subsystems.

The system of an embodiment integrates 1560 the functionality of theextant security system with other non-security devices including but notlimited to IP cameras, touchscreens, lighting controls, door lockingmechanisms, which may be controlled via RF, wired, or powerline-basednetworking mechanisms supported by the gateway or servers.

The system of an embodiment provides a user interface subsystem 1570enabling a user to monitor, manage, and control the system andassociated sensors and security systems. In an embodiment of the system,a user interface subsystem is an HTML/XML/Javascript/Java/AJAX/Flashpresentation of a monitoring and control application, enabling users toview the state of all sensors and controllers in the extant securitysystem from a web browser or equivalent operating on a computer, PDA,mobile phone, or other consumer device.

In another illustrative embodiment of the system described herein, auser interface subsystem is an HTML/XML/Javascript/Java/AJAXpresentation of a monitoring and control application, enabling users tocombine the monitoring and control of the extant security system andsensors with the monitoring and control of non-security devicesincluding but not limited to IP cameras, touchscreens, lightingcontrols, door locking mechanisms.

In another illustrative embodiment of the system described herein, auser interface subsystem is a mobile phone application enabling users tomonitor and control the extant security system as well as othernon-security devices.

In another illustrative embodiment of the system described herein, auser interface subsystem is an application running on a keypad ortouchscreen device enabling users to monitor and control the extantsecurity system as well as other non-security devices.

In another illustrative embodiment of the system described herein, auser interface subsystem is an application operating on a TV or set-topbox connected to a TV enabling users to monitor and control the extantsecurity system as well as other non-security devices.

FIG. 16 is a block diagram of an integrated security system 1600wirelessly interfacing to proprietary security systems, under anembodiment. A security system 1610 is coupled or connected to a Gateway1620, and from Gateway 1620 coupled or connected to a plurality ofinformation and content sources across a network 1630 including one ormore web servers 1640, system databases 1650, and applications servers1660. While in one embodiment network 1630 is the Internet, includingthe World Wide Web, those of skill in the art will appreciate thatnetwork 1630 may be any type of network, such as an intranet, anextranet, a virtual private network (VPN), a mobile network, or anon-TCP/IP based network.

Moreover, other elements of the system of an embodiment may beconventional, well-known elements that need not be explained in detailherein. For example, security system 1610 could be any type home orbusiness security system, such devices including but not limited to astandalone RF home security system or a non-RF-capable wired homesecurity system with an add-on RF interface module. In the integratedsecurity system 1600 of this example, security system 1610 includes anRF-capable wireless security panel (WSP) 1611 that acts as the mastercontroller for security system 1610. Well-known examples of such a WSPinclude the GE Security Concord, Networx, and Simon panels, theHoneywell Vista and Lynx panels, and similar panels from DSC and Napco,to name a few. A wireless module 1614 includes the RF hardware andprotocol software necessary to enable communication with and control ofa plurality of wireless devices 1613. WSP 1611 may also manage wireddevices 1614 physically connected to WSP 1611 with an RS232 or RS485 orEthernet connection or similar such wired interface.

In an implementation consistent with the systems and methods describedherein, Gateway 1620 provides the interface between security system 1610and LAN and/or WAN for purposes of remote control, monitoring, andmanagement. Gateway 1620 communicates with an external web server 1640,database 1650, and application server 1660 over network 1630 (which maycomprise WAN, LAN, or a combination thereof). In this example system,application logic, remote user interface functionality, as well as userstate and account are managed by the combination of these remoteservers. Gateway 1620 includes server connection manager 1621, asoftware interface module responsible for all server communication overnetwork 1630. Event manager 1622 implements the main event loop forGateway 1620, processing events received from device manager 1624(communicating with non-security system devices including but notlimited to IP cameras, wireless thermostats, or remote door locks).Event manager 1622 further processes events and control messages fromand to security system 1610 by utilizing WSP manager 1623.

WSP manager 1623 and device manager 1624 both rely upon wirelessprotocol manager 1626 which receives and stores the proprietary orstandards-based protocols required to support security system 1610 aswell as any other devices interfacing with gateway 1620. WSP manager1623 further utilizes the comprehensive protocols and interfacealgorithms for a plurality of security systems 1610 stored in the WSP DBclient database associated with wireless protocol manager 1626. Thesevarious components implement the software logic and protocols necessaryto communicate with and manager devices and security systems 1610.Wireless Transceiver hardware modules 1625 are then used to implementthe physical RF communications link to such devices and security systems1610. An illustrative wireless transceiver 1625 is the GE SecurityDialog circuit board, implementing a 319.5 MHz two-way RF transceivermodule. In this example, RF Link 1670 represents the 319.5 MHz RFcommunication link, enabling gateway 1620 to monitor and control WSP1611 and associated wireless and wired devices 1613 and 1614,respectively.

In one embodiment, server connection manager 1621 requests and receivesa set of wireless protocols for a specific security system 1610 (anillustrative example being that of the GE Security Concord panel andsensors) and stores them in the WSP DB portion of the wireless protocolmanager 1626. WSP manager 1623 then utilizes such protocols fromwireless protocol manager 1626 to initiate the sequence of processesdetailed in FIG. 15 and FIG. 16 for learning gateway 1620 into securitysystem 1610 as an authorized control device. Once learned in, asdescribed with reference to FIG. 16 (and above), event manager 1622processes all events and messages detected by the combination of WSPmanager 1623 and the GE Security wireless transceiver module 1625.

In another embodiment, gateway 1620 incorporates a plurality of wirelesstransceivers 1625 and associated protocols managed by wireless protocolmanager 1626. In this embodiment events and control of multipleheterogeneous devices may be coordinated with WSP 1611, wireless devices1613, and wired devices 1614. For example a wireless sensor from onemanufacturer may be utilized to control a device using a differentprotocol from a different manufacturer.

In another embodiment, gateway 1620 incorporates a wired interface tosecurity system 1610, and incorporates a plurality of wirelesstransceivers 1625 and associated protocols managed by wireless protocolmanager 1626. In this embodiment events and control of multipleheterogeneous devices may be coordinated with WSP 1611, wireless devices1613, and wired devices 1614.

Of course, while an illustrative embodiment of an architecture of thesystem of an embodiment is described in detail herein with respect toFIG. 16, one of skill in the art will understand that modifications tothis architecture may be made without departing from the scope of thedescription presented herein. For example, the functionality describedherein may be allocated differently between client and server, oramongst different server or processor-based components. Likewise, theentire functionality of the gateway 1620 described herein could beintegrated completely within an existing security system 1610. In suchan embodiment, the architecture could be directly integrated with asecurity system 1610 in a manner consistent with the currently describedembodiments.

FIG. 17 is a flow diagram for wirelessly ‘learning’ the Gateway into anexisting security system and discovering extant sensors, under anembodiment. The learning interfaces gateway 1620 with security system1610. Gateway 1620 powers up 1710 and initiates software sequences 1720and 1725 to identify accessible WSPs 1611 and wireless devices 1613,respectively (e.g., one or more WSPs and/or devices within range ofgateway 1620). Once identified, WSP 1611 is manually or automaticallyset into ‘learn mode’ 1730, and gateway 1620 utilizes availableprotocols to add 1740 itself as an authorized control device in securitysystem 1610. Upon successful completion of this task, WSP 1611 ismanually or automatically removed from ‘learn mode’ 1750.

Gateway 1620 utilizes the appropriate protocols to mimic 1760 the firstidentified device 1614. In this operation gateway 1620 identifies itselfusing the unique or pseudo-unique identifier of the first found device1614, and sends an appropriate change of state message over RF Link1670. In the event that WSP 1611 responds to this change of statemessage, the device 1614 is then added 1770 to the system in database1650. Gateway 1620 associates 1780 any other information (such as zonename or token-based identifier) with this device 1614 in database 1650,enabling gateway 1620, user interface modules, or any application toretrieve this associated information.

In the event that WSP 1611 does not respond to the change of statemessage, the device 1614 is not added 1770 to the system in database1650, and this device 1614 is identified as not being a part of securitysystem 1610 with a flag, and is either ignored or added as anindependent device, at the discretion of the system provisioning rules.Operations hereunder repeat 1785 operations 1760, 1770, 1780 for alldevices 1614 if applicable. Once all devices 1614 have been tested inthis way, the system begins operation 1790.

In another embodiment, gateway 1620 utilizes a wired connection to WSP1611, but also incorporates a wireless transceiver 1625 to communicatedirectly with devices 1614. In this embodiment, operations under 1720above are removed, and operations under 1740 above are modified so thesystem of this embodiment utilizes wireline protocols to add itself asan authorized control device in security system 1610.

A description of an example embodiment follows in which the Gateway(FIG. 16, element 1620) is the iHub available from iControl Networks,Palo Alto, Calif., and described in detail herein. In this example thegateway is “automatically” installed with a security system.

The automatic security system installation begins with the assignment ofan authorization key to components of the security system (e.g.,gateway, kit including the gateway, etc.). The assignment of anauthorization key is done in lieu of creating a user account. Aninstaller later places the gateway in a user's premises along with thepremises security system. The installer uses a computer to navigate to aweb portal (e.g., integrated security system web interface), logs in tothe portal, and enters the authorization key of the installed gatewayinto the web portal for authentication. Once authenticated, the gatewayautomatically discovers devices at the premises (e.g., sensors, cameras,light controls, etc.) and adds the discovered devices to the system or“network”. The installer assigns names to the devices, and testsoperation of the devices back to the server (e.g., did the door open,did the camera take a picture, etc.). The security device information isoptionally pushed or otherwise propagated to a security panel and/or tothe server network database. The installer finishes the installation,and instructs the end user on how to create an account, username, andpassword. At this time the user enters the authorization key whichvalidates the account creation (uses a valid authorization key toassociate the network with the user's account). New devices maysubsequently be added to the security network in a variety of ways(e.g., user first enters a unique ID for each device/sensor and names itin the server, after which the gateway can automatically discover andconfigure the device).

A description of another example embodiment follows in which thesecurity system (FIG. 16, element 1610) is a Dialog system and the WSP(FIG. 16, element 1611) is a SimonXT available from General ElectricSecurity, and the Gateway (FIG. 16, element 1620) is the iHub availablefrom iControl Networks, Palo Alto, Calif., and described in detailherein. Descriptions of the install process for the SimonXT and iHub arealso provided below.

GE Security's Dialog network is one of the most widely deployed andtested wireless security systems in the world. The physical RF networkis based on a 319.5 MHz unlicensed spectrum, with a bandwidth supportingup to 19 Kbps communications. Typical use of this bandwidth—even inconjunction with the integrated security system—is far less than that.Devices on this network can support either one-way communication (eithera transmitter or a receiver) or two-way communication (a transceiver).Certain GE Simon, Simon XT, and Concord security control panelsincorporate a two-way transceiver as a standard component. The gatewayalso incorporates the same two-way transceiver card. The physical linklayer of the network is managed by the transceiver module hardware andfirmware, while the coded payload bitstreams are made available to theapplication layer for processing.

Sensors in the Dialog network typically use a 60-bit protocol forcommunicating with the security panel transceiver, while security systemkeypads and the gateway use the encrypted 80-bit protocol. The Dialognetwork is configured for reliability, as well as low-power usage. Manydevices are supervised, i.e. they are regularly monitored by the system‘master’ (typically a GE security panel), while still maintainingexcellent power usage characteristics. A typical door window sensor hasa battery life in excess of 5-7 years.

The gateway has two modes of operation in the Dialog network: a firstmode of operation is when the gateway is configured or operates as a‘slave’ to the GE security panel; a second mode of operation is when thegateway is configured or operates as a ‘master’ to the system in theevent a security panel is not present. In both configurations, thegateway has the ability to ‘listen’ to network traffic, enabling thegateway to continually keep track of the status of all devices in thesystem. Similarly, in both situations the gateway can address andcontrol devices that support setting adjustments (such as the GEwireless thermostat).

In the configuration in which the gateway acts as a ‘slave’ to thesecurity panel, the gateway is ‘learned into’ the system as a GEwireless keypad. In this mode of operation, the gateway emulates asecurity system keypad when managing the security panel, and can querythe security panel for status and ‘listen’ to security panel events(such as alarm events).

The gateway incorporates an RF Transceiver manufactured by GE Security,but is not so limited. This transceiver implements the Dialog protocolsand handles all network message transmissions, receptions, and timing.As such, the physical, link, and protocol layers of the communicationsbetween the gateway and any GE device in the Dialog network are totallycompliant with GE Security specifications.

At the application level, the gateway emulates the behavior of a GEwireless keypad utilizing the GE Security 80-bit encrypted protocol, andonly supported protocols and network traffic are generated by thegateway. Extensions to the Dialog RF protocol of an embodiment enablefull control and configuration of the panel, and iControl can bothautomate installation and sensor enrollment as well as directconfiguration downloads for the panel under these protocol extensions.

As described above, the gateway participates in the GE Security networkat the customer premises. Because the gateway has intelligence and atwo-way transceiver, it can ‘hear’ all of the traffic on that network.The gateway makes use of the periodic sensor updates, state changes, andsupervisory signals of the network to maintain a current state of thepremises. This data is relayed to the integrated security system server(e.g., FIG. 2, element 260) and stored in the event repository for useby other server components. This usage of the GE Security RF network iscompletely non-invasive; there is no new data traffic created to supportthis activity.

The gateway can directly (or indirectly through the Simon XT panel)control two-way devices on the network. For example, the gateway candirect a GE Security Thermostat to change its setting to ‘Cool’ from‘Off’, as well as request an update on the current temperature of theroom. The gateway performs these functions using the existing GE Dialogprotocols, with little to no impact on the network; a gateway devicecontrol or data request takes only a few dozen bytes of data in anetwork that can support 19 Kbps.

By enrolling with the Simon XT as a wireless keypad, as describedherein, the gateway includes data or information of all alarm events, aswell as state changes relevant to the security panel. This informationis transferred to the gateway as encrypted packets in the same way thatthe information is transferred to all other wireless keypads on thenetwork.

Because of its status as an authorized keypad, the gateway can alsoinitiate the same panel commands that a keypad can initiate. Forexample, the gateway can arm or disarm the panel using the standardDialog protocol for this activity. Other than the monitoring of standardalarm events like other network keypads, the only incremental datatraffic on the network as a result of the gateway is the infrequentremote arm/disarm events that the gateway initiates, or infrequentqueries on the state of the panel.

The gateway is enrolled into the Simon XT panel as a ‘slave’ devicewhich, in an embodiment, is a wireless keypad. This enables the gatewayfor all necessary functionality for operating the Simon XT systemremotely, as well as combining the actions and information ofnon-security devices such as lighting or door locks with GE Securitydevices. The only resource taken up by the gateway in this scenario isone wireless zone (sensor ID).

The gateway of an embodiment supports three forms of sensor and panelenrollment/installation into the integrated security system, but is notlimited to this number of enrollment/installation options. Theenrollment/installation options of an embodiment include installerinstallation, kitting, and panel, each of which is described below.

Under the installer option, the installer enters the sensor IDs at timeof installation into the integrated security system web portal oriScreen. This technique is supported in all configurations andinstallations.

Kits can be pre-provisioned using integrated security systemprovisioning applications when using the kitting option. At kittingtime, multiple sensors are automatically associated with an account, andat install time there is no additional work required.

In the case where a panel is installed with sensors already enrolled(i.e. using the GE Simon XT enrollment process), the gateway has thecapability to automatically extract the sensor information from thesystem and incorporate it into the user account on the integratedsecurity system server.

The gateway and integrated security system of an embodiment uses anauto-learn process for sensor and panel enrollment in an embodiment. Thedeployment approach of an embodiment can use additional interfaces thatGE Security is adding to the Simon XT panel. With these interfaces, thegateway has the capability to remotely enroll sensors in the panelautomatically. The interfaces include, but are not limited to, thefollowing: EnrollDevice (ID, type, name, zone, group);SetDeviceParameters (ID, type, Name, zone, group), GetDeviceParameters(zone); and RemoveDevice (zone).

The integrated security system incorporates these new interfaces intothe system, providing the following install process. The install processcan include integrated security system logistics to handle kitting andpre-provisioning. Pre-kitting and logistics can include apre-provisioning kitting tool provided by integrated security systemthat enables a security system vendor or provider (“provider”) to offerpre-packaged initial ‘kits’. This is not required but is recommended forsimplifying the install process. This example assumes a ‘Basic’ kit ispreassembled and includes one (1) Simon XT, three (3) Door/windowsensors, one (1) motion sensor, one (1) gateway, one (1) keyfob, two (2)cameras, and ethernet cables. The kit also includes a sticker page withall Zones (1-24) and Names (full name list).

The provider uses the integrated security system kitting tool toassemble ‘Basic’ kit packages. The contents of different types ofstarter kits may be defined by the provider. At the distributionwarehouse, a worker uses a bar code scanner to scan each sensor and thegateway as it is packed into the box. An ID label is created that isattached to the box. The scanning process automatically associates allthe devices with one kit, and the new ID label is the unique identifierof the kit. These boxes are then sent to the provider for distributionto installer warehouses. Individual sensors, cameras, etc. are also sentto the provider installer warehouse. Each is labeled with its ownbarcode/ID.

An installation and enrollment procedure of a security system includinga gateway is described below as one example of the installation process.

1. Order and Physical Install Process

-   -   a. Once an order is generated in the iControl system, an account        is created and an install ticket is created and sent        electronically to the provider for assignment to an installer.    -   b. The assigned installer picks up his/her ticket(s) and fills        his/her truck with Basic and/or Advanced starter kits. He/she        also keeps a stock of individual sensors, cameras, iHubs, Simon        XTs, etc. Optionally, the installer can also stock homeplug        adapters for problematic installations.    -   c. The installer arrives at the address on the ticket, and pulls        out the Basic kit. The installer determines sensor locations        from a tour of the premises and discussion with the homeowner.        At this point assume the homeowner requests additional equipment        including an extra camera, two (2) additional door/window        sensors, one (1) glass break detector, and one (1) smoke        detector.    -   d. Installer mounts SimonXT in the kitchen or other location in        the home as directed by the homeowner, and routes the phone line        to Simon XT if available. GPRS and Phone numbers pre-programmed        in SimonXT to point to the provider Central Monitoring Station        (CMS).    -   e. Installer places gateway in the home in the vicinity of a        router and cable modem. Installer installs an ethernet line from        gateway to router and plugs gateway into an electrical outlet.        2. Associate and Enroll gateway into SimonXT    -   a. Installer uses either his/her own laptop plugged into router,        or homeowners computer to go to the integrated security system        web interface and log in with installer ID/pass.    -   b. Installer enters ticket number into admin interface, and        clicks ‘New Install’ button. Screen prompts installer for kit ID        (on box's barcode label).    -   c. Installer clicks ‘Add SimonXT’. Instructions prompt installer        to put Simon XT into install mode, and add gateway as a wireless        keypad. It is noted that this step is for security only and can        be automated in an embodiment.    -   d. Installer enters the installer code into the Simon XT.        Installer Learns ‘gateway’ into the panel as a wireless keypad        as a group 1 device.    -   e. Installer goes back to Web portal, and clicks the ‘Finished        Adding SimonXT’ button.        3. Enroll Sensors into SimonXT via iControl    -   a. All devices in the Basic kit are already associated with the        user's account.    -   b. For additional devices, Installer clicks ‘Add Device’ and        adds the additional camera to the user's account (by typing in        the camera ID/Serial #).    -   c. Installer clicks ‘Add Device’ and adds other sensors (two (2)        door/window sensors, one (1) glass break sensor, and one (1)        smoke sensor) to the account (e.g., by typing in IDs).    -   d. As part of Add Device, Installer assigns zone, name, and        group to the sensor. Installer puts appropriate Zone and Name        sticker on the sensor temporarily.    -   e. All sensor information for the account is pushed or otherwise        propagated to the iConnect server, and is available to propagate        to CMS automation software through the CMS application        programming interface (API).    -   f. Web interface displays ‘Installing Sensors in System . . . ’        and automatically adds all of the sensors to the Simon XT panel        through the GE RF link.    -   g. Web interface displays ‘Done Installing’→all sensors show        green.        4. Place and Tests Sensors in Home    -   a. Installer physically mounts each sensor in its desired        location, and removes the stickers.    -   b. Installer physically mounts WiFi cameras in their location        and plugs into AC power. Optional fishing of low voltage wire        through wall to remove dangling wires. Camera transformer is        still plugged into outlet but wire is now inside the wall.    -   c. Installer goes to Web interface and is prompted for automatic        camera install. Each camera is provisioned as a private,        encrypted Wifi device on the gateway secured sandbox network,        and firewall NAT traversal is initiated. Upon completion the        customer is prompted to test the security system.    -   d. Installer selects the ‘Test System’ button on the web        portal—the SimonXT is put into Test mode by the gateway over GE        RF.    -   e. Installer manually tests the operation of each sensor,        receiving an audible confirmation from SimonXT.    -   f. gateway sends test data directly to CMS over broadband link,        as well as storing the test data in the user's account for        subsequent report generation.    -   g. Installer exits test mode from the Web portal.        5. Installer instructs customer on use of the Simon XT, and        shows customer how to log into the iControl web and mobile        portals. Customer creates a username/password at this time.        6. Installer instructs customer how to change Simon XT user code        from the Web interface. Customer changes user code which is        pushed to SimonXT automatically over GE RF.

An installation and enrollment procedure of a security system includinga gateway is described below as an alternative example of theinstallation process. This installation process is for use for enrollingsensors into the SimonXT and integrated security system and iscompatible with all existing GE Simon panels.

The integrated security system supports all pre-kitting functionalitydescribed in the installation process above. However, for the purpose ofthe following example, no kitting is used.

1. Order and Physical Install Process

-   -   a. Once an order is generated in the iControl system, an account        is created and an install ticket is created and sent        electronically to the security system provider for assignment to        an installer.    -   b. The assigned installer picks up his/her ticket(s) and fills        his/her truck with individual sensors, cameras, iHubs, Simon        XTs, etc. Optionally, the installer can also stock homeplug        adapters for problematic installations.    -   c. The installer arrives at the address on the ticket, and        analyzes the house and talks with the homeowner to determine        sensor locations. At this point assume the homeowner requests        three (3) cameras, five (5) door/window sensors, one (1) glass        break detector, one (1) smoke detector, and one (1) keyfob.    -   d. Installer mounts SimonXT in the kitchen or other location in        the home. The installer routes a phone line to Simon XT if        available. GPRS and Phone numbers are pre-programmed in SimonXT        to point to the provider CMS.    -   e. Installer places gateway in home in the vicinity of a router        and cable modem, and installs an ethernet line from gateway to        the router, and plugs gateway into an electrical outlet.        2. Associate and Enroll gateway into SimonXT    -   a. Installer uses either his/her own laptop plugged into router,        or homeowners computer to go to the integrated security system        web interface and log in with an installer ID/pass.    -   b. Installer enters ticket number into admin interface, and        clicks ‘New Install’ button. Screen prompts installer to add        devices.    -   c. Installer types in ID of gateway, and it is associated with        the user's account.    -   d. Installer clicks ‘Add Device’ and adds the cameras to the        user's account (by typing in the camera ID/Serial #).    -   e. Installer clicks ‘Add SimonXT’. Instructions prompt installer        to put Simon XT into install mode, and add gateway as a wireless        keypad.    -   f. Installer goes to Simon XT and enters the installer code into        the Simon XT. Learns ‘gateway’ into the panel as a wireless        keypad as group 1 type sensor.    -   g. Installer returns to Web portal, and clicks the ‘Finished        Adding SimonXT’ button.    -   h. Gateway now is alerted to all subsequent installs over the        security system RF.        3. Enroll Sensors into SimonXT via iControl    -   a. Installer clicks ‘Add Simon XT Sensors’—Displays instructions        for adding sensors to Simon XT.

b. Installer goes to Simon XT and uses Simon XT install process to addeach sensor, assigning zone, name, group. These assignments are recordedfor later use.

-   -   c. The gateway automatically detects each sensor addition and        adds the new sensor to the integrated security system.    -   d. Installer exits install mode on the Simon XT, and returns to        the Web portal.    -   e. Installer clicks ‘Done Adding Devices’.    -   f. Installer enters zone/sensor naming from recorded notes into        integrated security system to associate sensors to friendly        names.    -   g. All sensor information for the account is pushed to the        iConnect server, and is available to propagate to CMS automation        software through the CMS API.        4. Place and Tests Sensors in Home    -   a. Installer physically mounts each sensor in its desired        location.    -   b. Installer physically mounts Wifi cameras in their location        and plugs into AC power. Optional fishing of low voltage wire        through wall to remove dangling wires. Camera transformer is        still plugged into outlet but wire is now inside the wall.    -   c. Installer puts SimonXT into Test mode from the keypad.    -   d. Installer manually tests the operation of each sensor,        receiving an audible confirmation from SimonXT.    -   e. Installer exits test mode from the Simon XT keypad.    -   f. Installer returns to web interface and is prompted to        automatically set up cameras. After waiting for completion        cameras are now provisioned and operational.        5. Installer instructs customer on use of the Simon XT, and        shows customer how to log into the integrated security system        web and mobile portals. Customer creates a username/password at        this time.        6. Customer and Installer observe that all sensors/cameras are        green.        7. Installer instructs customer how to change Simon XT user code        from the keypad. Customer changes user code and stores in        SimonXT.        8. The first time the customer uses the web portal to Arm/Disarm        system the web interface prompts the customer for the user code,        which is then stored securely on the server. In the event the        user code is changed on the panel the web interface once again        prompts the customer.

The panel of an embodiment can be programmed remotely. The CMS pushesnew programming to SimonXT over a telephone or GPRS link. Optionally,iControl and GE provide a broadband link or coupling to the gateway andthen a link from the gateway to the Simon XT over GE RF.

In addition to the configurations described above, the gateway of anembodiment supports takeover configurations in which it is introduced oradded into a legacy security system. A description of example takeoverconfigurations follow in which the security system (FIG. 2, element 210)is a Dialog system and the WSP (FIG. 2, element 211) is a GE Concordpanel (e.g., equipped with POTS, GE RF, and Superbus 2000 RS485interface (in the case of a Lynx takeover the Simon XT is used)available from General Electric Security. The gateway (FIG. 2, element220) in the takeover configurations is an iHub (e.g., equipped withbuilt-in 802.11b/g router, Ethernet Hub, GSM/GPRS card, RS485 interface,and iControl Honeywell-compatible RF card) available from iControlNetworks, Palo Alto, Calif. While components of particular manufacturersare used in this example, the embodiments are not limited to thesecomponents or to components from these vendors.

The security system can optionally include RF wireless sensors (e.g., GEwireless sensors utilizing the GE Dialog RF technology), IP cameras, aGE-iControl Touchscreen (the touchscreen is assumed to be an optionalcomponent in the configurations described herein, and is thus treatedseparately from the iHub; in systems in which the touchscreen is acomponent of the base security package, the integrated iScreen(available from iControl Networks, Palo Alto, Calif.) can be used tocombine iHub technology with the touchscreen in a single unit), andZ-Wave devices to name a few.

The takeover configurations described below assume takeover by a “new”system of an embodiment of a security system provided by another thirdparty vendor, referred to herein as an “original” or “legacy” system.Generally, the takeover begins with removal of the control panel andkeypad of the legacy system. A GE Concord panel is installed to replacethe control panel of the legacy system along with an iHub with GPRSModem. The legacy system sensors are then connected or wired to theConcord panel, and a GE keypad or touchscreen is installed to replacethe control panel of the legacy system. The iHub includes the iControlRF card, which is compatible with the legacy system. The iHub finds andmanages the wireless sensors of the legacy system, and learns thesensors into the Concord by emulating the corresponding GE sensors. TheiHub effectively acts as a relay for legacy wireless sensors.

Once takeover is complete, the new security system provides ahomogeneous system that removes the compromises inherent in taking overor replacing a legacy system. For example, the new system provides amodern touchscreen that may include additional functionality, newservices, and supports integration of sensors from variousmanufacturers. Furthermore, lower support costs can be realized becausecall centers, installers, etc. are only required to support onearchitecture. Additionally, there is minimal install cost because onlythe panel is required to be replaced as a result of the configurationflexibility offered by the iHub.

The system takeover configurations described below include but are notlimited to a dedicated wireless configuration, a dedicated wirelessconfiguration that includes a touchscreen, and a fished Ethernetconfiguration. Each of these configurations is described in detailbelow.

FIG. 18 is a block diagram of a security system in which the legacypanel is replaced with a GE Concord panel wirelessly coupled to an iHub,under an embodiment. All existing wired and RF sensors remain in place.The iHub is located near the Concord panel, and communicates with thepanel via the 802.11 link, but is not so limited. The iHub managescameras through a built-in 802.11 router. The iHub listens to theexisting RF HW sensors, and relays sensor information to the Concordpanel (emulating the equivalent GE sensor). The wired sensors of thelegacy system are connected to the wired zones on the control panel.

FIG. 19 is a block diagram of a security system in which the legacypanel is replaced with a GE Concord panel wirelessly coupled to an iHub,and a GE-iControl Touchscreen, under an embodiment. All existing wiredand RF sensors remain in place. The iHub is located near the Concordpanel, and communicates with the panel via the 802.11 link, but is notso limited. The iHub manages cameras through a built-in 802.11 router.The iHub listens to the existing RF HW sensors, and relays sensorinformation to the Concord panel (emulating the equivalent GE sensor).The wired sensors of the legacy system are connected to the wired zoneson the control panel.

The GE-iControl Touchscreen can be used with either of an 802.11connection or Ethernet connection with the iHub. Because the takeoverinvolves a GE Concord panel (or Simon XT), the touchscreen is always anoption. No extra wiring is required for the touchscreen as it can usethe 4-wire set from the replaced keypad of the legacy system. Thisprovides power, battery backup (through Concord), and data link (RS485Superbus 2000) between Concord and touchscreen. The touchscreen receivesits broadband connectivity through the dedicated 802.11 link to theiHub.

FIG. 20 is a block diagram of a security system in which the legacypanel is replaced with a GE Concord panel connected to an iHub via anEthernet coupling, under an embodiment. All existing wired and RFsensors remain in place. The iHub is located near the Concord panel, andwired to the panel using a 4-wire SUperbus 2000 (RS485) interface, butis not so limited. The iHub manages cameras through a built-in 802.11router. The iHub listens to the existing RF HW sensors, and relayssensor information to the Concord panel (emulating the equivalent GEsensor). The wired sensors of the legacy system are connected to thewired zones on the control panel.

The takeover installation process is similar to the installation processdescribed above, except the control panel of the legacy system isreplaced; therefore, only the differences with the installationdescribed above are provided here. The takeover approach of anembodiment uses the existing RS485 control interfaces that GE Securityand iControl support with the iHub, touchscreen, and Concord panel. Withthese interfaces, the iHub is capable of automatically enrolling sensorsin the panel. The exception is the leverage of an iControl RF cardcompatible with legacy systems to ‘takeover’ existing RF sensors. Adescription of the takeover installation process follows.

During the installation process, the iHub uses an RF Takeover Card toautomatically extract all sensor IDs, zones, and names from the legacypanel. The installer removes connections at the legacy panel fromhardwired wired sensors and labels each with the zone. The installerpulls the legacy panel and replaces it with the GE Concord panel. Theinstaller also pulls the existing legacy keypad and replaces it witheither a GE keypad or a GE-iControl touchscreen. The installer connectslegacy hardwired sensors to appropriate wired zone (from labels) on theConcord. The installer connects the iHub to the local network andconnects the iHub RS485 interface to the Concord panel. The iHubautomatically ‘enrolls’ legacy RF sensors into the Concord panel as GEsensors (maps IDs), and pushes or otherwise propagates other informationgathered from HW panel (zone, name, group). The installer performs atest of all sensors back to CMS. In operation, the iHub relays legacysensor data to the Concord panel, emulating equivalent GE sensorbehavior and protocols.

The areas of the installation process particular to the legacy takeoverinclude how the iHub extracts sensor info from the legacy panel and howthe iHub automatically enrolls legacy RF sensors and populates Concordwith wired zone information. Each of these areas is described below.

In having the iHub extract sensor information from the legacy panel, theinstaller ‘enrolls’ iHub into the legacy panel as a wireless keypad (useinstall code and house ID—available from panel). The iHub legacy RFTakeover Card is a compatible legacy RF transceiver. The installer usesthe web portal to place iHub into ‘Takeover Mode’, and the web portalthe automatically instructs the iHub to begin extraction. The iHubqueries the panel over the RF link (to get all zone information for allsensors, wired and RF). The iHub then stores the legacy sensorinformation received during the queries on the iConnect server.

The iHub also automatically enrolls legacy RF sensors and populatesConcord with wired zone information. In so doing, the installer selects‘Enroll legacy Sensors into Concord’ (next step in ‘Takeover’ process onweb portal). The iHub automatically queries the iConnect server, anddownloads legacy sensor information previously extracted. The downloadedinformation includes an ID mapping from legacy ID to ‘spoofed’ GE ID.This mapping is stored on the server as part of the sensor information(e.g., the iConnect server knows that the sensor is a legacy sensoracting in GE mode). The iHub instructs Concord to go into install mode,and sends appropriate Superbus 2000 commands for sensor learning to thepanel. For each sensor, the ‘spoofed’ GE ID is loaded, and zone, name,and group are set based on information extracted from legacy panel. Uponcompletion, the iHub notifies the server, and the web portal is updatedto reflect next phase of Takeover (e.g., ‘Test Sensors’).

Sensors are tested in the same manner as described above. When a 11 Wsensor is triggered, the signal is captured by the iHub legacy RFTakeover Card, translated to the equivalent GE RF sensor signal, andpushed to the panel as a sensor event on the SuperBus 2000 wires.

In support of remote programming of the panel, CMS pushes newprogramming to Concord over a phone line, or to the iConnect CMS/AlarmServer API, which in turn pushes the programming to the iHub. The iHubuses the Concord Superbus 2000 RS485 link to push the programming to theConcord panel.

FIG. 21 is a flow diagram for automatic takeover 2100 of a securitysystem, under an embodiment. Automatic takeover includes establishing2102 a wireless coupling between a takeover component running under aprocessor and a first controller of a security system installed at afirst location. The security system includes some number of securitysystem components coupled to the first controller. The automatictakeover includes automatically extracting 2104 security data of thesecurity system from the first controller via the takeover component.The automatic takeover includes automatically transferring 2106 thesecurity data to a second controller and controlling loading of thesecurity data into the second controller. The second controller iscoupled to the security system components and replaces the firstcontroller.

FIG. 22 is a flow diagram for automatic takeover 2200 of a securitysystem, under an alternative embodiment. Automatic takeover includesautomatically forming 2202 a security network at a first location byestablishing a wireless coupling between a security system and agateway. The gateway of an embodiment includes a takeover component. Thesecurity system of an embodiment includes security system components.The automatic takeover includes automatically extracting 2204 securitydata of the security system from a first controller of the securitysystem. The automatic takeover includes automatically transferring 2206the security data to a second controller. The second controller of anembodiment is coupled to the security system components and replaces thefirst controller.

Components of the gateway of the integrated security system describedherein control discovery, installation and configuration of both wiredand wireless IP devices (e.g., cameras, etc.) coupled or connected tothe system, as described herein with reference to FIGS. 1-4, as well asmanagement of video routing using a video routing module or engine. Thevideo routing engine initiates communication paths for the transfer ofvideo from a streaming source device to a requesting client device, anddelivers seamless video streams to the user via the communication pathsusing one or more of UPnP port-forwarding, relay server routing andSTUN/TURN peer-to-peer routing, each of which is described below.

By way of reference, conventional video cameras have the ability tostream digital video in a variety of formats and over a variety ofnetworks. Internet protocol (IP) video cameras, which include videocameras using an IP transport network (e.g., Ethernet, WiFi (IEEE 802.11standards), etc.) are prevalent and increasingly being utilized in homemonitoring and security system applications. With the proliferation ofthe internet, Ethernet and WiFi local area networks (LANs) and advancedwide area networks (WANs) that offer high bandwidth, low latencyconnections (broadband), as well as more advanced wireless WAN datanetworks (e.g. GPRS or CDMA 1×RTT), there increasingly exists thenetworking capability to extend traditional security systems to offerIP-based video. However, a fundamental reason for such IP video in asecurity system is to enable a user or security provider to monitor liveor otherwise streamed video from outside the host premises (and theassociated LAN).

The conventional solution to this problem has involved a technique knownas ‘port fowarding’, whereby a ‘port’ on the LAN's router/firewall isassigned to the specific LAN IP address for an IP camera, or a proxy tothat camera. Once a port has been ‘forwarded’ in this manner, a computerexternal to the LAN can address the LAN's router directly, and requestaccess to that port. This access request is then forwarded by the routerdirectly to the IP address specified, the IP camera or proxy. In thisway an external device can directly access an IP camera within the LANand view or control the streamed video.

The issues with this conventional approach include the following: portforwarding is highly technical and most users do not know how/why to doit; automatic port forwarding is difficult and problematic usingemerging standards like UPnP; the camera IP address is often reset inresponse to a power outage/router reboot event; there are many differentrouters with different ways/capabilities for port forwarding. In short,although port forwarding can work, it is frequently less than adequateto support a broadly deployed security solution utilizing IP cameras.

Another approach to accessing streaming video externally to a LANutilizes peer-to-peer networking technology. So-called peer-to-peernetworks, which includes networks in which a device or client isconnected directly to another device or client, typically over a WideArea Network (WAN) and without a persistent server connection, areincreasingly common. In addition to being used for the sharing of filesbetween computers (e.g., Napster and KaZaa), peer-to-peer networks havealso been more recently utilized to facilitate direct audio and mediastreaming in applications such as Skype. In these cases, thepeer-to-peer communications have been utilized to enable telephony-stylevoice communications and video conferencing between two computers, eachenabled with an IP-based microphone, speaker, and video camera. Afundamental reason for adopting such peer-to-peer technology is theability to transparently ‘punch through’ LAN firewalls to enableexternal access to the streaming voice and video content, and to do soin a way that scales to tens of millions of users without creating anuntenable server load.

A limitation of the conventional peer-to-peer video transport lies inthe personal computer (PC)-centric nature of the solution. Each of theconventional solutions uses a highly capable PC connected to the videocamera, with the PC providing the advanced software functionalityrequired to initiate and manage the peer-to-peer connection with theremote client. A typical security or remote home monitoring systemrequires multiple cameras, each with its own unique IP address, and onlya limited amount of processing capability in each camera such that theconventional PC-centric approach cannot easily solve the need. Insteadof a typical PC-centric architecture with three components (a “3-way IPVideo System”) that include a computer device with video camera, amediating server, and a PC client with video display capability, theconventional security system adds a plurality of fourth components thatare standalone IP video cameras (requiring a “4-way IP Video System”),another less-than-ideal solution.

In accordance with the embodiments described herein, IP cameramanagement systems and methods are provided that enable a consumer orsecurity provider to easily and automatically configure and manage IPcameras located at a customer premise. Using this system IP cameramanagement may be extended to remote control and monitoring from outsidethe firewall and router of the customer premise.

With reference to FIGS. 5 and 6, the system includes a gateway 253having a video routing component so that the gateway 253 can manage andcontrol, or assist in management and control, or video routing. Thesystem also includes one or more cameras (e.g., WiFi IP camera 254,Ethernet IP camera 255, etc.) that communicate over the LAN 250 using anIP format, as well as a connection management server 210 located outsidethe premise firewall 252 and connected to the gateway 253 by a Wide AreaNetwork (WAN) 200. The system further includes one or more devices 220,230, 240 located outside the premise and behind other firewalls 221,231, 241 and connected to the WAN 200. The other devices 220, 230, 240are configured to access video or audio content from the IP cameraswithin the premise, as described above.

Alternatively, with reference to FIGS. 9 and 10, the system includes atouchscreen 902 or 1002 having a video routing component so that thetouchscreen 902 or 1002 can manage and control, or assist in managementand control, or video routing. The system also includes one or morecameras (e.g., WiFi IP camera 254, Ethernet IP camera 255, etc.) thatcommunicate over the LAN 250 using an IP format, as well as a connectionmanagement server 210 located outside the premise firewall 252 andconnected to the gateway 253 by a Wide Area Network (WAN) 200. Thesystem further includes one or more devices 220, 230, 240 locatedoutside the premise and behind other firewalls 221, 231, 241 andconnected to the WAN 200. The other devices 220, 230, 240 are configuredto access video or audio content from the IP cameras within the premise,as described above.

FIG. 23 is a general flow diagram for IP video control, under anembodiment. The IP video control interfaces, manages, and providesWAN-based remote access to a plurality of IP cameras in conjunction witha home security or remote home monitoring system. The IP video controlallows for monitoring and controlling of IP video cameras from alocation remote to the customer premise, outside the customer premisefirewall, and protected by another firewall. Operations begin when thesystem is powered on 2310, involving at a minimum the power-on of thegateway, as well as the power-on of at least one IP camera coupled orconnected to the premise LAN. The gateway searches 2311 for available IPcameras and associated IP addresses. The gateway selects 2312 from oneor more possible approaches to create connections between the IP cameraand a device external to the firewall. Once an appropriate connectionpath is selected, the gateway begins operation 2313, and awaits 2320 arequest for a stream from one of the plurality of IP video camerasavailable on the LAN. When a stream request is present the serverretrieves 2321 the requestor's WAN IP address/port.

When a server relay is present 2330, the IP camera is instructed 2331 tostream to the server, and the connection is managed 2332 through theserver. In response to the stream terminating 2351, operations return togateway operation 2313, and waits to receive another request 2320 for astream from one of the plurality of IP video cameras available on theLAN.

When a server relay is not present 2330, the requestor's WAN IPaddress/port is provided 2333 to the gateway or gateway relay. When agateway relay is present 2340, the IP camera is instructed 2341 tostream to the gateway, and the gateway relays 2342 the connection to therequestor. In response to the stream terminating 2351, operations returnto gateway operation 2313, and waits to receive another request 2320 fora stream from one of the plurality of IP video cameras available on theLAN. When a gateway relay is not present 2340, the IP camera isinstructed 2343 to stream to an address, and a handoff 2344 is maderesulting in direct communication between the camera and the requestor.In response to the stream terminating 2351, operations return to gatewayoperation 2313, and waits to receive another request 2320 from one ofthe plurality of IP video cameras available on the LAN.

The integrated security system of an embodiment supports numerous videostream formats or types of video streams. Supported video streamsinclude, but are not limited to, Motion Picture Experts Group (MPEG)-4(MPEG-4)/Real-Time Streaming Protocol (RTSP), MPEG-4 over HypertextTransfer Protocol (HTTP), and Motion Joint Photographic Experts Group(JPEG) (MJPEG).

The integrated security system of an embodiment supports the MPEG-4/RTSPvideo streaming method (supported by video servers and clients) whichuses RTSP for the control channel and Real-time Transport Protocol (RTP)for the data channel. Here the RTSP channel is over Transmission ControlProtocol (TCP) while the data channel uses User Datagram Protocol (UDP).This method is widely supported by both streaming sources (e.g.,cameras) and stream clients (e.g., remote client devices, AppleQuicklime, VideoLAN, IPTV mobile phones, etc).

Encryption can be added to the two channels under MPEG-4/RTSP. Forexample, the RTSP control channel can be encrypted using SSL/TLS. Thedata channel can also be encrypted.

If the camera or video stream source inside the home does not supportencryption for either RTSP or RTP channels, the gateway located on theLAN can facilitate the encrypted RTSP method by maintaining separate TCPsessions with the video stream source device and with the encrypted RTSPclient outside the LAN, and relay all communication between the twosessions. In this situation, any communication between the gateway andthe video stream source that is not encrypted could be encrypted by thegateway before being relayed to the RTSP client outside the LAN. In manycases the gateway is an access point for the encrypted and private Wifinetwork on which the video stream source device is located. This meansthat communication between the gateway and the video stream sourcedevice is encrypted at the network level, and communication between thegateway and the RTSP client is encrypted at the transport level. In thisfashion the gateway can compensate for a device that does not supportencrypted RTSP.

The integrated security system of an embodiment also supports reverseRTSP. Reverse RTSP includes taking a TCP-based protocol like RTSP, andreversing the roles of client and server (references to “server” includethe iControl server, also referred to as the iConnect server) when itcomes to TCP session establishment. For example, in standard RTSP theRTSP client is the one that establishes the TCP connection with thestream source server (the server listens on a port for incomingconnections). In Reverse RTSP, the RTSP client listens on a port forincoming connections from the stream source server. Once the TCPconnection is established, the RTSP client begins sending commands tothe server over the TCP connection just as it would in standard RTSP.

When using Reverse RTSP, the video stream source is generally on a LAN,protected by a firewall. Having a device on the LAN initiate theconnection to the RTSP client outside the firewall enables easy networktraversal.

If the camera or video stream source inside the LAN does not supportReverse RTSP, then the gateway facilitates the Reverse RTSP method byinitiating separate TCP sessions with the video stream source device andwith the Reverse RTSP client outside the LAN, and then relays allcommunication between the two sessions. In this fashion the gatewaycompensates for a stream source device that does not support ReverseRTSP.

As described in the encryption description above, the gateway canfurther compensate for missing functionalities on the device such asencryption. If the device does not support encryption for either RTSP orRTP channels, the gateway can communicate with the device using theseun-encrypted streams, and then encrypt the streams before relaying themout of the LAN to the RTSP Reverse client.

Servers of the integrated security system can compensate for RTSPclients that do not support Reverse RTSP. In this situation, the serveraccepts TCP connections from both the RTSP client and the Reverse RTSPvideo stream source (which could be a gateway acting on behalf of astream source device that does not support Reverse RTSP). The serverthen relays the control and video streams from the Reverse RTSP videostream source to the RTSP client. The server can further compensate forthe encryption capabilities of the RTSP client; if the RTSP client doesnot support encryption then the server can provide an unencrypted streamto the RTSP client even though an encrypted stream was received from theReverse RTSP streaming video source.

The integrated security system of an embodiment also supports SimpleTraversal of User Datagram Protocol (UDP) through Network AddressTranslators (NAT) (STUN)/Traversal Using Relay NAT (TURN) peer-to-peerrouting. STUN and Turn are techniques for using a server to helpestablish a peer-to-peer UDP data stream (it does not apply to TCPstreams). The bandwidth consumed by the data channel of a video streamis usually many thousands of times larger than that used by the controlchannel. Consequently, when a peer-to-peer connection for both the RTSPand RTP channels is not possible, there is still a great incentive touse STUN/TURN techniques in order to achieve a peer-to-peer connectionfor the RTP data channel.

Here, a method referred to herein as RTSP with STUN/TURN is used by theintegrated security system. The RTSP with STUN/TURN is a method in whichthe video streaming device is instructed over the control channel tostream its UDP data channel to a different network address than that ofthe other end of the control TCP connection (usually the UDP data issimply streamed to the IP address of the RTSP client). The result isthat the RTSP or Reverse RTSP TCP channel can be relayed using thegateway and/or the server, while the RTP UDP data channel can flowdirectly from the video stream source device to the video stream client.

If a video stream source device does not support RTSP with STUN/TURN,the gateway can compensate for the device by relaying the RTSP controlchannel via the server to the RTSP client, and receiving the RTP datachannel and then forwarding it directly to the RTSP with STUN/TURNenabled client. Encryption can also be added here by the gateway.

The integrated security system of an embodiment supports MPEG-4 overHTTP. MPEG-4 over HTTP is similar to MPEG-4 over RTSP except that boththe RTSP control channel and the RTP data channel are passed over anHTTP TCP session. Here a single TCP session can be used, splitting itinto multiple channels using common HTTP techniques like chunkedtransfer encoding.

The MPEG-4 over HTTP is generally supported by many video stream clientsand server devices, and encryption can easily be added to it usingSSL/TLS. Because it uses TCP for both channels, STUN/TURN techniques maynot apply in the event that a direct peer-to-peer TCP session betweenclient and server cannot be established.

As described above, encryption can be provided using SSL/TLS taking theform of HTTPS. And as with MPEG-4 over RTSP, a gateway can compensatefor a stream source device that does not support encryption by relayingthe TCP streams and encrypting the TCP stream between the gateway andthe stream client. In many cases the gateway is an access point for theencrypted and private Wifi network on which the video stream sourcedevice is located. This means that communication between the gateway andthe video stream source device is encrypted at the network level, andcommunication between the gateway and the video stream client isencrypted at the transport level. In this fashion the gateway cancompensate for a device that does not support HTTPS.

As with Reverse RTSP, the integrated security system of an embodimentsupports Reverse HTTP. Reverse HTTP includes taking a TCP-based protocollike HTTP, and reversing the roles of client and server when it comes toTCP session establishment. For example, in conventional HTTP the HTTPclient is the one that establishes the TCP connection with the server(the server listens on a port for incoming connections). In ReverseHTTP, the HTTP client listens on a port for incoming connections fromthe server. Once the TCP connection is established, the HTTP clientbegins sending commands to the server over the TCP connection just as itwould in standard HTTP.

When using Reverse HTTP, the video stream source is generally on a LAN,protected by a firewall. Having a device on the LAN initiate theconnection to the HTTP client outside the firewall enables easy networktraversal.

If the camera or video stream source inside the LAN does not supportReverse HTTP, then the gateway can facilitate the Reverse HTTP method byinitiating separate TCP sessions with the video stream source device andwith the Reverse HTTP client outside the LAN, and then relay allcommunication between the two sessions. In this fashion the gateway cancompensate for a stream source device that does not support ReverseHTTP.

As described in the encryption description above, the gateway canfurther compensate for missing functionalities on the device such asencryption. If the device does not support encrypted HTTP (e.g., HTTPS),then the gateway can communicate with the device using HTTP, and thenencrypt the TCP stream(s) before relaying out of the LAN to the ReverseHTTP client.

The servers of an embodiment can compensate for HTTP clients that do notsupport Reverse HTTP. In this situation, the server accepts TCPconnections from both the HTTP client and the Reverse HTTP video streamsource (which could be a gateway acting on behalf of a stream sourcedevice that does not support Reverse HTTP). The server then relays theTCP streams from the Reverse HTTP video stream source to the HTTPclient. The server can further compensate for the encryptioncapabilities of the HTTP client; if the HTTP client does not supportencryption then the server can provide an unencrypted stream to the HTTPclient even though an encrypted stream was received from the ReverseHTTP streaming video source.

The integrated security system of an embodiment supports MJPEG asdescribed above. MJPEG is a streaming technique in which a series of JPGimages are sent as the result of an HTTP request. Because MJPEG streamsare transmitted over HTTP, HTTPS can be employed for encryption and mostMJPEG clients support the resulting encrypted stream. And as with MPEG-4over HTTP, a gateway can compensate for a stream source device that doesnot support encryption by relaying the TCP streams and encrypting theTCP stream between the gateway and the stream client. In many cases thegateway is an access point for the encrypted and private Wifi network onwhich the video stream source device is located. This means thatcommunication between the gateway and the video stream source device isencrypted at the network level, and communication between the gatewayand the video stream client is encrypted at the transport level. In thisfashion the gateway can compensate for a device that does not supportHTTPS.

The integrated system of an embodiment supports Reverse HTTP. ReverseHTTP includes taking a TCP-based protocol like HTTP, and reversal of theroles of client and server when it comes to TCP session establishmentcan be employed for MJPEG streams. For example, in standard HTTP theHTTP client is the one who establishes the TCP connection with theserver (the server listens on a port for incoming connections). InReverse HTTP, the HTTP client listens on a port for incoming connectionsfrom the server. Once the TCP connection is established, the HTTP clientbegins sending commands to the server over the TCP connection just as itwould in standard HTTP.

When using Reverse HTTP, the video stream source is generally on a LAN,protected by a firewall. Having a device on the LAN initiate theconnection to the HTTP client outside the firewall enables networktraversal.

If the camera or video stream source inside the LAN does not supportReverse HTTP, then the gateway can facilitate the Reverse HTTP method byinitiating separate TCP sessions with the video stream source device andwith the Reverse HTTP client outside the LAN, and then relay allcommunication between the two sessions. In this fashion the gateway cancompensate for a stream source device that does not support ReverseHTTP.

As described in the encryption description above, the gateway canfurther compensate for missing functionalities on the device such asencryption. If the device does not support encrypted HTTP (e.g., HTTPS),then the gateway can communicate with the device using HTTP, and thenencrypt the TCP stream(s) before relaying out of the LAN to the ReverseHTTP client.

The servers can compensate for HTTP clients that do not support ReverseHTTP. In this situation, the server accepts TCP connections from boththe HTTP client and the Reverse HTTP video stream source (which could bea gateway acting on behalf of a stream source device that does notsupport Reverse HTTP). The server then relays the TCP streams from theReverse HTTP video stream source to the HTTP client. The server canfurther compensate for the encryption capabilities of the HTTP client;if the HTTP client does not support encryption then the server canprovide an unencrypted stream to the HTTP client even though anencrypted stream was received from the Reverse HTTP streaming videosource.

The integrated security system of an embodiment considers numerousparameters in determining or selecting one of the streaming formatsdescribed above for use in transferring video streams. The parametersconsidered in selecting a streaming format include, but are not limitedto, security requirements, client capabilities, device capabilities, andnetwork/system capabilities.

The security requirements for a video stream are considered indetermining an applicable streaming format in an embodiment. Securityrequirements fall into two categories, authentication and privacy, eachof which is described below.

Authentication as a security requirement means that stream clients mustpresent credentials in order to obtain a stream. Furthermore, thispresentation of credentials should be done in a way that is secure fromnetwork snooping and replays. An example of secure authentication isBasic Authentication over HTTPS. Here a username and password arepresented over an encrypted HTTPS channel so snooping and replays areprevented. Basic Authentication alone, however, is generally notsufficient for secure authentication.

Because not all streaming clients support SSL/TLS, authenticationmethods that do not require it are desirable. Such methods includeDigest Authentication and one-time requests. A one-time request is arequest that can only be made by a client one time, and the serverprevents a reuse of the same request. One-time requests are used tocontrol access to a stream source device by stream clients that do notsupport SSL/TLS. An example here is providing video access to a mobilephone. Typical mobile phone MPEG-4 viewers do not support encryption. Inthis case, one of the MPEG-4 over RTSP methods described above can beemployed to get the video stream relayed to an server. The server canthen provide the mobile phone with a one-time request Universal ResourceLocator (URL) for the relayed video stream source (via a WirelessApplication Protocol (WAP) page). Once the stream ends, the mobile phonewould need to obtain another one-time request URL from the server (viaWAP, for example) in order to view the stream again.

Privacy as a security requirement means that the contents of the videostream must be encrypted. This is a requirement that may be impossibleto satisfy on clients that do not support video stream encryption, forexample many mobile phones. If a client supports encryption for somevideo stream format(s), then the “best” of those formats should beselected. Here “best” is determined by the stream type priorityalgorithm.

The client capabilities are considered in determining an applicablestreaming format in an embodiment. In considering client capabilities,the selection depends upon the supported video stream formats thatinclude encryption, and the supported video stream formats that do notsupport encryption.

The device capabilities are considered in determining an applicablestreaming format in an embodiment. In considering device capabilities,the selection depends upon the supported video stream formats thatinclude encryption, the supported video stream formats that do notsupport encryption, and whether the device is on an encrypted privateWifi network managed by the gateway (in which case encryption at thenetwork level is not required).

The network/system capabilities are considered in determining anapplicable streaming format in an embodiment. In consideringnetwork/system capabilities, the selection depends upon characteristicsof the network or system across which the stream must travel. Thecharacteristics considered include, for example, the following: whetherthere is a gateway and/or server on the network to facilitate some ofthe fancier video streaming types or security requirements; whether theclient is on the same LAN as the gateway, meaning that network firewalltraversal is not needed.

Streaming methods with the highest priority are peer-to-peer becausethey scale best with server resources. Universal Plug and Play (UPnP)can be used by the gateway to open ports on the video stream device'sLAN router and direct traffic through those ports to the video streamdevice. This allows a video stream client to talk directly with thevideo stream device or talk directly with the gateway which can in turnfacilitate communication with the video stream device.

Another factor in determining the best video stream format to use is thesuccess of STUN and TURN methods for establishing direct peer-to-peerUDP communication between the stream source device and the streamclient. Again, the gateway and the server can help with the setup ofthis communication.

Client bandwidth availability and processing power are other factors indetermining the best streaming methods. For example, due to itsbandwidth overhead an encrypted MJPEG stream should not be consideredfor most mobile phone data networks.

Device bandwidth availability can also be considered in choosing thebest video stream format. For example, consideration can be given towhether the upstream bandwidth capabilities of the typical residentialDSL support two or more simultaneous MJPEG streams.

Components of the integrated security system of an embodiment, whileconsidering various parameters in selecting a video streaming format totransfer video streams from streaming source devices and requestingclient devices, prioritize streaming formats according to theseparameters. The parameters considered in selecting a streaming formatinclude, as described above, security requirements, client capabilities,device capabilities, and network/system capabilities. Components of theintegrated security system of an embodiment select a video streamingformat according to the following priority, but alternative embodimentscan use other priorities.

The selected format is UPnP or peer-to-peer MPEG-4 over RTSP withencryption when both requesting client device and streaming sourcedevice support this format.

The selected format is UPnP or peer-to-peer MPEG-4 over RTSP withauthentication when the requesting client device does not supportencryption or UPnP or peer-to-peer MPEG-4 over RTSP with encryption.

The selected format is UPnP (peer-to-peer) MPEG-4 over HTTPS when bothrequesting client device and streaming source device support thisformat.

The selected format is UPnP (peer-to-peer) MPEG-4 over HTTP when therequesting client device does not support encryption or UPnP(peer-to-peer) MPEG-4 over HTTPS.

The selected format is UPnP (peer-to-peer) MPEG-4 over RTSP facilitatedby gateway or touchscreen (including or incorporating gatewaycomponents) (to provide encryption), when the requesting client devicesupports encrypted RTSP and the streaming source device supports MPEG-4over RTSP.

The selected format is UPnP (peer-to-peer) MPEG-4 over HTTPS facilitatedby gateway or touchscreen (including or incorporating gatewaycomponents) (to provide encryption) when the requesting client devicesupports MPEG-4 over HTTPS and the streaming source device supportsMPEG-4 over HTTP.

The selected format is UPnP (peer-to-peer) MJPEG over HTTPS when thenetworks and devices can handle the bandwidth and both requesting clientdevice and streaming source device support MJPEG over HTTPS.

The selected format is Reverse RTSP with STUN/TURN facilitated by theserver when the streaming source device initiates SSL/TLS TCP to server,the streaming source device supports Reverse RTSP over SSL/TLS withSTUN/TURN, and the requesting client device supports RTSP withSTUN/TURN.

The selected format is Reverse RTSP with STUN/TURN facilitated by serverand gateway or touchscreen (including or incorporating gatewaycomponents) when the gateway initiates SSL/TLS TCP to the server and tothe streaming source device, the streaming source device supports RTSP,and the requesting client device supports RTSP with STUN/TURN.

The selected format is Reverse MPEG over RTSP/HTTP facilitated by theserver when the streaming source device initiates SSL/TLS TCP to server,the streaming source device supports Reverse RTSP or HTTP over SSL/TLS,and the requesting client device supports MPEG over RTSP/HTTP.

The selected format is Reverse MPEG over RTSP/HTTP facilitated by serverand gateway or touchscreen (including or incorporating gatewaycomponents) when the gateway initiates SSL/TLS TCP to server and tostreaming source device, the streaming source device supports MPEG overRTSP or HTTP, and the requesting client device supports MPEG overRTSP/HTTP.

The selected format is UPnP (peer-to-peer) MJPEG over HTTP when thenetworks and devices can handle the bandwidth and when the requestingclient device does not support encryption and does not support MPEG-4.

The selected format is Reverse MJPEG over HTTPS facilitated by theserver when the streaming source device initiates SSL/TLS TCP to server,the streaming source device supports Reverse MJPEG over SSL/TLS, and therequesting client device supports MJPEG.

The selected format is Reverse MJPEG over HTTPS facilitated by serverand gateway or touchscreen (including or incorporating gatewaycomponents) when the gateway initiates SSL/TLS TCP to the server and tothe streaming source device, the streaming source device supports MJPEG,and the requesting client device supports MJPEG.

FIG. 24 is a block diagram showing camera tunneling, under anembodiment.

Additional detailed description of camera tunnel implementation detailsfollow.

An embodiment uses XMPP for communication with a remote video camera asa lightweight (bandwidth) method for maintaining real-time communicationwith the remote camera. More specifically, the remote camera is locatedon another NAT (e.g., NAT traversal).

An embodiment comprises a method for including a remotely located camerain a home automation system. For example, using XMPP via cloud XMPPserver to couple or connect camera to home automation system. This canbe used with in-car cameras, cell phone cameras, and re-locatablecameras (e.g., dropped in the office, the hotel room, the neighbor'shouse, etc.).

Components of an embodiment are distributed so that any one can beoffline while system continues to function (e.g., panel can be downwhile camera still up, motion detection from camera, video clip uploadetc. continue to work.

Embodiments extend the PSIA in one or more of the following areas: wifiroaming configuration; video relay commands; wifi connectivity test;media tunnel for live video streaming in the context of a securitysystem; motion notification mechanism and configuration (motionheartbeat) (e.g., helps with scalable server); XMPP for lightweightcommunication (helps with scalable server, reduced bandwidth, formaintaining persistent connection with a gateway); ping request sentover XMPP as health check mechanism; shared secret authenticationbootstrapping process; asynchronous error status delivery by the camerafor commands invoked by the gateway if the camera is responsible fordelivering errors to the gateway in an asynchronous fashion (e.g.,gateway requests a firmware update or a video clip upload).

Embodiments extend the home automation system to devices located onseparate networks, and make them useable as general-purposecommunication devices. These cameras can be placed in the office,vacation home, neighbor house, software can be put onto a cell phone,into a car, navigation system, etc.

Embodiments use a global device registry for enabling a device/camera tolocate the server and home to which it is assigned.

Embodiments include methods for bootstrapping and re-bootstrapping ofauthentication credentials. The methods include activation key entry byinstaller into the cloud web interface. Activation key generation isbased upon mac address and a shared secret between manufacturer and theservice provider. Embodiments of the system allow activation of a camerawith valid activation key that is not already provisioned in the globalregistry server.

Embodiments include a web-based interface for use in activating,configuring, remote firmware update, and re-configuring of a camera.

Embodiments process or locate local wifi access points and provide theseas options during camera configuring and re-configuring. Embodimentsgenerate and provide recommendations around choosing a best wifi accesspoint based upon characteristics of the network (e.g., signal strength,error rates, interference, etc.). Embodiments include methods fortesting and diagnosing issues with wifi and network access.

Embodiments include cameras able to perform this wifi test using onlyone physical network interface, an approach that enables the camera todynamically change this physical interface from wired to wifi.Embodiments are able to change the network settings (wifi etc) remotelyusing the same process.

Cameras of an embodiment can be configured with multiple networkpreferences with priority order so that the camera can move betweendifferent locations and the camera can automatically find the bestnetwork to join (e.g., can have multiple ssid+bssid+password setsconfigured and prioritized).

Regarding firmware download, embodiments include a mechanism to monitorthe status of the firmware update, provide feedback to the end user andimprove overall quality of the system.

Embodiments use RTSP over SSL to a cloud media relay server to allowlive video NAT traversal to a remote client (e.g., PC, cell phone, etc.)in a secure manner where the camera provides media sessionauthentication credentials to the server. The camera initiates the SSLconnection to the cloud and then acts as a RTSP server over thisconnection.

Embodiments include methods for using NAT traversal for connecting tothe cloud for remote management and live video access allows theintegrated security components to avoid port forwarding on the localrouter(s) and as a result maintain a more secure local network and amore secure camera since no ports are required to be open.

Embodiments enable camera sensors (e.g., motion, audio, heat, etc.) toserve as triggers to other actions in the automation system. The captureof video clips or snapshots from the camera is one such action, but theembodiments are not so limited.

A camera of an embodiment can be used by multiple systems.

A detailed description of flows follows relating to the camera tunnel ofan embodiment.

A detailed description of camera startup and installation follows as itpertains to the camera tunnel of an embodiment.

Activation Key

-   -   a. camera to follow same algorithm as ihub where activation key        is generated from serial based upon a one-way hash on serial and        a per-vendor shared secret.    -   b. Used com.icontrol.util.ops.activation.ActivationKeyUtil class        to validate serialNo <-> activationKey.        Registry Request        [partner]/registry/[device type]/[serial]    -   a. new column in existing registry table for id type; nullable        but the application treats null as “gateway”.    -   b. rest endpoints allow adding with the new optional argument.    -   c. current serial and siteId uniqueness enforcement by        application depends upon device type (for any device type, there        should be uniqueness on serial; for gateway device type, there        should be uniqueness on siteId; for other device types, there        need not be uniqueness on siteId).    -   d. if no activation yet (e.g., no entry) then send dummy        response (random but repeatable reply; may include predictable        “dummy” so that steps below can infer.    -   e. add/update registry server endpoints for adding/updating        entries.        If Camera has No Password        Camera retrieves “Pending Key” via POST to        /<CredentialGatewayURL>/GatewayService/<siteID>/PendingDeviceKey.    -   a. pending key request (to get password) with serial and        activation key.    -   b. server checks for dummy reply; if dummy then responds with        retry backoff response.    -   c. server invokes pass-through API on gateway to get new pending        key.    -   d. if device is found, then gateway performs validation of        serial+activation key, returns error if mismatch.    -   e. if activation key checks out, then gateway checks pending key        status.    -   f. if device currently has a pending key status, then a new        pending password is generated.    -   g. gateway maintains this authorization information in a new set        of variables on the camera device.    -   h. device-authorization/session-key comprises the current        connected password.    -   i. device-authorization/pending-expiry comprises a UTC timestamp        representing the time the current pending password period ends;        any value less than the current time or blank means the device        is not in a pending password state.    -   j. device-authorization/pending-session-key comprises the last        password returned to the camera in a pending request; this is        optional (device may choose to maintain this value in memory).    -   k. session-key and pending-session-key variables tagged with        “encryption” in the device def which causes rest and admin to        hide their value from client.        ConnectInfo Request    -   a. returns xmpp host and port to connect to (comes from config        as it does for gateway connect info).    -   b. returns connectInfo with additional <xmpp> parameter.        Start Portal Add Camera Wizard    -   a. user enters camera serial, activation key.    -   b. addDevice rest endpoint on gateway called    -   c. gateway verifies activation key is correct.    -   d. gateway calls addDevice method on gapp server to add        LWG_SerComm_iCamera_1000 with given serial to site.    -   e. Server detects the camera type and populates registry.    -   f. gateway puts device into pending password state (e.g.,        updates device-auth/pending-expiry point).    -   g. rest endpoints on gateway device for managing device pending        password state.    -   h. start pending password state: POST future UTC value to        device-auth/pending-expiry; device-auth/pending-expiry set to 30        minutes from time device was added.    -   i. stop pending password state: POST −1 to        device-auth/pending-expiry.    -   j. check pending password state: GET device-auth/pending-expiry.    -   k. message returned with “Location” header pointing to relative        URI.    -   l. user told to power on camera (or reboot if already powered        on).    -   m. once camera connects, gateway updates        device-auth/pending-expiry to −1 and device-auth/session-key        with password and device/connection-status to connected    -   n. portal polls for device/connection-status to change to        connected; if does not connect after X seconds, bring up error        page (camera has not connected—continue waiting or start over).    -   o. user asked if wifi should be configured for this camera.    -   p. entry fields for wifi ssid and password.    -   q. portal can pre-populate ssid and password fields with        picklist of any from other cameras on the site.    -   r. get XML of available SSIDs.    -   s. non-wifi option is allowed.    -   t. portal submits options to configure camera (use null values        to specify non-wifi); upon success, message is returned with        “Location” header pointing to relative URI.    -   u. checks configuration progress and extracting “status” and        “subState” fields.    -   v. puts device state into “configuring”; upon error, puts device        state into “configuration failure”.    -   w. performs firmware upgrade if needed, placing device state        into “upgrading”; upon error, puts device state into “upgrade        failure”.    -   x. upon configuration success, puts device state of “ok” and        applies appropriate configuration for camera (e.g., resolutions,        users, etc.).    -   y. if non-blank wifi parameters, automatically perform “wifi        test” method to test wifi without disconnecting Ethernet.    -   z. portal wizard polls device status until changes to “ok” or        “upgrade failure/“configuration failure” in “status” field,        along with applicable, if any, with error code reason, in        “subState” field; upon error, show details to user, provide        options (start over, configure again, reboot, factory reset,        etc)    -   aa. notify user they can move camera to desired location.        Camera Reboots    -   a. gets siteId and server URL from registry.    -   b. makes pending paid key request to server specifying correct        siteId, serial and activation key; gets back pending password.    -   c. makes connectInfo request to get xmpp server.    -   d. connects over xmpp with pending password.        If Camera Reboots Again    -   a. get siteId and server URL from registry.    -   b. already has password (may or may not be pending) so no need        to perform pending paid key request.    -   c. make connectInfo request to get xmpp server.    -   d. connect over xmpp with password.        xmpp Connect with Password    -   a. xmpp user is of the form [serial]@[server]/[siteId]    -   b. session server performs authentication by making passthrough        API request to gateway for given SiteId.    -   c. Session xmpp server authenticates new session using DeviceKey        received in GET request against received xmpp client credential.    -   d. If authentication fails or GET receives non-response, server        returns to camera XMPP connect retry backoff with long backoff.    -   e. gateway device performs password management.    -   f. compares password with current key and pending key (if not        expired); if matches pending, then update        device-auth/session-key to be pending value, and clear out the        device-auth/pending-expiry.    -   g. gateway device updates the device/connection-status point to        reflect that camera is connected.    -   h. gateway device tracks the xmpp session server this camera is        connected to via new point device/proxy-host and updates this        info if changed.    -   i. if deviceConnected returns message, then session server posts        connected event containing xmpp user to queue monitored by all        session servers.    -   j. session servers monitor these events and disconnect/cleanup        sessions they have for same user.    -   k. may use new API endpoint on session server for broadcast        messages.        xmpp Connect with Bad Password    -   a. Upon receiving a new connection request, session server        performs authentication by making passthrough API request to        gateway for given SiteId.    -   b. Session xmpp server authenticates new session using DeviceKey        received in above GET request against received xmpp client        credential.    -   c. If authentication fails or GET receives non-response from        virtual gateway.    -   d. Session server rejects incoming connection (is there a        backoff/retry XMPP response that can be sent here).    -   e. Session server logs event.    -   f. Gateway logs event.        xmpp Disconnect    -   a. session server posts disconnected event to gateway (with        session server name).    -   b. gateway updates the device/connected variable/point to        reflect that camera is disconnected.    -   c. gateway updates the device/connection-status variable/point        to reflect that camera is disconnected.    -   d. gateway clears the device/proxy-host point that contains the        session host to this camera is connected.        LWGW Shutdown    -   a. During LWGW shutdown, gateway can broadcast messages to all        XMPP servers to ensure all active XMPP sessions are gracefully        shutdown.    -   b. gateways use REST client to call URI, which will broadcast to        all XMPP servers.        To Configure Camera During Installation    -   a. applies all appropriate configuration for camera (e.g.,        resolutions, users, etc).    -   b. returns message for configuration applied, wifi test passed,        all settings taken.

returns other response code with error code description upon anyfailure.

To Reconfigure Wifi SSID and Key

-   -   a. returns message for wifi credentials set.    -   b. returns other response code with error code description upon        any failure.        API Pass-Through Handling for Gateway Fail-Over Case    -   a. When performing passthrough for LWGW, the API endpoint        handles the LWGW failover case (e.g., when gateway is not        currently running on any session server).    -   b. passthrough functions in the following way: current session        server IP is maintained on the gateway object; server looks up        gateway object to get session IP and then sends passthrough        request to that session server; if that request returns gateway        not found message, server error message, or a network level        error (e.g., cannot route to host, etc.), if the gateway is a        LWGW then server should lookup the primary/secondary LW Gateway        group for this site; server should then send resume message to        primary, followed by rest request; if that fails, then server        send resume message to secondary followed by rest request    -   c. alternatively, passthrough functions in the following way:        rather than lookup session server IP on gateway object,        passthrough requests should be posted to a passthrough queue        that is monitored by all session servers; the session server        with the Gateway on it should consume the message (and pass it        to the appropriate gateway); the server should monitor for        expiry of these messages, and if the gateway is a LWGW then        server should lookup the primary/secondary LW Gateway group for        this site; server should then send resume message to primary,        followed by rest request; if that fails, then server send resume        message to secondary followed by rest request.

A detailed description follows for additional flows relating to thecamera tunnel of an embodiment.

Motion Detection

-   -   a. camera sends openhome motion event to session server via        xmpp.    -   b. session server posts motion event to gateway via passthrough        API.    -   c. gateway updates the camera motion variable/point to reflect        the event gateway updates the camera motion variable/point to        reflect the event        Capture Snapshot    -   a. gateway posts openhome snapshot command to session server        with camera connected.    -   b. gateway sends command including xmpp user id to xmpp command        Queue monitored by all session servers.    -   c. session server with given xmpp user id consumes command and        sends command to camera (command contains upload URL on gw        webapp).    -   d. gateway starts internal timer to check if a response is        received from camera (e.g., 5 sec wait window).    -   e. if broadcast RabbitMQ not ready, then gateway will use        device/proxy-host value to know which session server to post        command to.    -   f. session server sends command to camera (comprises upload URL        on gw webapp)    -   g. Example XML body:        -   <MediaUpload>        -   <id>1321896772660</id>        -   <snapShotImageType>JPEG</snapShotImageType>        -   <gateway_url>[gatewaysyncUrl]/gw/GatewayService/SPutJpg/s/[siteId]/[deviceIndex]/[varValue]/[varIndex]/[who]/[ts]/[HMM]/[passCheck]/</<failure_url>[gatewaysyncUrl]/gw/GatewayService/SPutJpgError/s/[siteId]/[deviceIndex]/[varValue]/[varIndex]/[who]/[ts]/[HMM]/[passCheck]/</</MediaUpload>    -   h. session server receives response to sendRequestEvent from        camera and posts response to gateway.    -   i. camera uploads to upload URL on gw webapp.    -   j. passCheck can be verified on server (based upon gateway        secret); alternatively, the OpenHome spec calls for Digest Auth        here.    -   k. endpoint responds with message digest password if the URI is        expected, otherwise returns non-response.    -   l. gw webapp stores snapshot, logs history event.    -   m. event is posted to gateway for deltas.        Capture Clip    -   a. gateway posts openhome video clip capture command to session        server with camera connected.    -   b. gateway sends command including xmpp user id to xmpp command        Queue monitored by all session servers.    -   c. session server with given xmpp user id consumes command and        sends command to camera (command comprises upload URL on gw        webapp).    -   d. gateway starts internal timer to check if a response is        received from camera (e.g., 5 sec wait window).    -   e. session server sends command to camera (comprises upload URL        on gw webapp).    -   f. Example URI from session server to camera:        -   /openhome/streaming/channels/1/video/upload    -   g. Example XML body:        -   <MediaUpload>        -   <id>1321898092270</id>        -   <videoClipFormatType>MP4</videoClipFormatType>        -   <gateway_url>[gatewaysyncUrl]/gw/GatewayService/SPutMpeg/s/[siteId]/[deviceIndex]/[varValueNvarIndex]/[who]/[ts]/[liMM]/[passCheck]/</<failure_url>[gatewaysyncUrl]/gw/GatewayService/SPutMpegFailed/s/[siteId]/[deviceIndex]/[varValueNvarIndex]/[who]/[ts]/[HMM]/[passCheck]/</        -   </MediaUpload>    -   h. session server receives response to sendRequestEvent from        camera and posts response to gateway.    -   i. camera uploads to upload URL on gw webapp.    -   j. passCheck can be verified on server (based upon gateway        secret).    -   k. alternatively, spec calls for Digest Auth here.    -   l. endpoint responds with message digest password if the URI is        expected, otherwise returns non-response.    -   m. gw webapp stores video clip, logs history event.    -   n. event is posted to gateway for deltas.        Live Video (Relay)    -   a. Upon user login to portal, portal creates a media relay        tunnel by calling relayAPImanager create.    -   b. RelayAPImanager creates relays and sends ip-config-relay        variable (which instructs gateway to create media tunnel) to        gateway.    -   c. Upon receiving media tunnel create ip-config-relay command,        gateway posts openhome media channel create command to session        server with camera connected.    -   d. session server sends create media tunnel command to camera        (comprises camera relay URL on relay server).    -   e. Example URI from session server to camera:        -   /openhome/streaming/mediatunnel/create    -   f. Example XML body:        -   <CreateMediaTunnel>        -   <sessionID>1</sessionID>        -   <gatewayURL>TBD</gatewayURL>        -   <failureURL>TBD</failureURL>        -   </CreateMediaTunnel>    -   g. GatewayURL is created from relay server, port, and sessionId        info included within ip-config-relay variable.    -   h. camera creates a TLS tunnel to relay server via POST to        <gatewayURL>.    -   i. When user initiates live video, portal determines user is        remote and retrieves URL of Relay server from relayAPImanager.    -   j. Upon receiving a user pole connection on the relay server        (along with valid rtsp request), relay sends streaming command        to camera: example:        -   rtsp:://openhome/streaming/channels/1/rtsp    -   k. Upon user portal logout, portals calls relayAPImanager to        terminate media tunnel.    -   l. RelayAPImanager send ip-config-relay variable to terminate        media tunnel.    -   m. Gateway sends destroy media tunnel command to camera via        XMPP.        Camera Firmware Update    -   a. Gateway checks camera firmware version; if below minimum        version, gateway sends command to camera (via session server) to        upgrade firmware (command: /openhome/system/updatefirmware).    -   b. Gateway checks firmware update status by polling:        -   /openhome/system/updatefirmware/status.    -   c. Gateway informs portal of upgrade status.    -   d. Camera auto-reboots after firmware update and reconnects to        Session server.        Camera First-Contact Configuration    -   a. After a camera is added successfully and is connected to the        session server for the first time, gateway performs first        contact configuration as follows.    -   b. Check firmware version.    -   c. Configure settings by: download config file using        /openhome/sysetm/configurationData/configFile; or configure each        category individually (configure video input channel settings        —/openhome/system/video/inputs/channels; onfigure audio input        channel settings (if        any)—/openhome/system/audio/inputs/channels; configure video        streaming channel settings—/openhome/streaming/channels;        configure motion detection settings—example:        PUT/openhome/custom/motiondetection/pir/0; configure event        trigger settings—example: PUT/openhome/custom/event).    -   d. Reboot camera (/openhome/system/factoryreset) if camera        responds with reboot required.

Embodiments described herein include one or more protocols enablingcommunications between one or more system components described herein(e.g., gateway, touchscreen, IP devices, security system, etc.). Moreparticularly, details follow of an interface specification (CLIENT JSONVIEW MODEL SPECIFICATION) in an example embodiment of the integratedsecurity system described herein.

Client JSON View Model Specification

Goals of this Client View Model

To improve quality and enabled us to more easily add and maintainclients, we are enhancing our platform RESTful interfaces to normalizeinformation about devices, security panels and system states.

These enhancements provided by the platform (iHub or server) should:

-   -   provide the minimal data for iControl Connect clients    -   centralize business logic—platform to provide meta information        such as what to hide (silent alarms), sort order, and virtual        data (such as what orb to show)    -   remove state machines from clients—platform should convey what        is possible at any given time (such as ability to disarm, etc.)    -   provide error handling—handle request delays and failures        clearly (in this doc, this applies to security actions)    -   handle language and format lookup—given lang/locale code in        request, will respond with resolved strings    -   be efficient for all clients—track changes and minimize updates        using deltas, reduce data size, and reduce # nodes

In the example below, the client REST data is about 20% the size (aftergzip) of the raw REST instances, and about 10% the number of nodes toparse. More importantly, all the business logic has been baked into thedata, and most of the need for partner preference lookup.

Client View Model Overview

In order to support the goals, the new REST extensions will returneither XML or JSON data, based on client request. In this spec, we'lluse XML, with these general types:

-   -   1. singletons—are atomic objects, each with a unique name.        Client REST delivers complete items, nothing smaller, and there        is only ever 1 per site. For example, there is only one shift        object, and one site object. Most singletons are required—they        will always be provided as part of the model (such as a summary        or security object). Some are conditional, and their existence        causes UI to appear (like energy, or cameras groups).    -   2. groups—are atomic objects, each with a unique name. Group        contain an array of items (often, 1 per device) or an empty        array to indicate there are no items of that type but they could        exist.    -   3. group items—are instance objects, each with a unique ID. For        example, you may have a group of 2 doorlocks items, and later        update a single doorlock item using its unique ID.    -   4. values—are key/value pairs contained in items and commands.        Items can be strings, boolean, long ints, or floats.    -   5. commands—provide actions the user can invoke on the system        (server or iHub). They contain input objects with possible        values (and sometimes current value).    -   6. controls—provide local actions, like navigation.

For example, a client REST request may return:

“client”: { “ts”: 98782636856, “version”: 2.1, “actionURI”:“/mobile/rest/icontrol/client/0060350419d7/”, //any actions should beappended to this (if they don't start with / ) “aSingletonObject”: {//each singleton has a unique name  “type”: “mySingleton”,  “keyX”:“valueX”,  “keyY”: “valueY” }, “anotherSingletonObject”: {  ... },“aGroupObject”: { //each group has a unique name, there can be only one “id”: “aGroupObject”,  “name”: “My Group Object”, //localized name forgroup (may be used for tab, etc.)  “numTrouble”: 0, //if > 0, entiregroup may be flagged as containing a troubled object  “items”: [  {“id”: 321, //there can be multiple items, so they get unique IDs “tags”:“sometag1,sometag2”, //may be used to differentiate items of differenttypes “state”: { //the state object tells local UI what data may not befresh  “icon”: someIconId,  “statusTxt”: “a value that normally changes” “commandElement”: 3 }, “commands”: { //commands are actions that can besent to the system  “commandElement”: { //each command gets a uniquename to help UI layout “action”: “bar?fixedParam=fixedParamValue”,“method”: “post”, “params”: {...}  }, }  }, },  }, “anotherGroupObject”: [ {...}, {...}, {...}  ]

Top level objects (keys, singleton objects, and groups) are named forquick lookup, and deltas may will deliver individual singletons, groups,or items.

Now the client can easily refer to these objects, and data bind them tothe UI:

var lightlname=client.lighting.items[0].name;

Commands—Building Blocks for Requesting Actions

Command elements provide a way for user to request actions, such aschanging sites, arming a panel, or changing a light dimmer.Model-defined controls are for submitting changes to the system, not forlocal view navigation (like changing tabs): they generally result inspecific parameterized requests.

Commands do not dictate the specific UI used. They should indicate thecurrent value, possible new values, and a way to submit those actions tothe server. Our current commands/parameters are:

-   -   request—make a change or request data    -   select—show a value, send new value from list    -   toggle—like select, but only 2 values and shows future value    -   range—select a numeric value with a control and send that number    -   textInput—enter a text value, ensure it matches a regular        expression, and send it

Note that there are rare commands that have multiple parameters ofdifferent types. For example, an arm command could have an option(toggle param) and request a PIN (textInput param). Only the requestcommand has no param list so it has a type at the top-level; othercommands just have a type for each parameter.

Request:

A request command is as simple action request that changes the system.It has no parameters the view would need to define. For example, a SignOut link. See FIG. 25.

“signOut”: { “method”: “post”, “action”: “/ui/client/site/signOut”,//rest URL to submit action (may be appended to a base URI)“label”: “Sign Out”,  “busyStatusTxt”: “Signing Out...” //Text to show(optional) after  request is submitted  }

The client could show a button or a link with label “Sign Out”. Whenclicked, it would send a REST http request as shown below. This commandhas NO optional parameters.

Sample Request

POSThttp://host:port/mobile/rest/icontrol/ui/operations?method=POST&actionqui/client/site/signOut

The response from this command would be a operation object:

Sample Response from the Command Request

operation:{“id”:“630cf35e-e8bb-4957-b81d-4c961677da37”,“ts”:1358411674097,“status”:“pending”}

Later a full update status fromhttp://host:port/mobile/rest/icontrol/ui/updates endpoint would indicatethe result of the above operation.

Requests may also be used to get data, for example a history request:

“getNotableEvents”: { “type”: “history”, //type of command. This onetypically rendered as a clock icon“action”: “site/foo/bar/getHistory?tags=notableEvents”, //rest URL tosubmit action (may be appended to a base URI) “label”: “Notable Events”//localized label. May use an icon and ignore this. “optionalParams”: { “maxEvents”: { “defaultValue”: 50 }, //if specified, don't fetch morethan this many events  “maxTime”: { “defaultValue”: “2d” } //ifspecified, don't get events more than 2 days ago (also can be h=hours,w=weeks) }  }

This command can be used as-is, but it also has optional parameters theUI can expose.

Select:

A selection command parameter is like a a list of requests, each with adiscrete label and value to submit. The UI should show the current valueas selected, and allow the use to choose a new value from the list. Forexample, see FIG. 26 for selecting thermostat modes.

“setMode”: { “action”: “foo/bar/mode”, “method”: “post”, “params”: { “mode”: { “type”: “select”, “options”: [  { “value”: “auto”, “label”:“Auto Mode” },  { “value”: “heat”, “label”: “Heat” },  { “value”:“cool”, “label”: “Cool” },  { “value”: “off” , “label”: “Off” } ]  } } }

Any of the labels can be selected, and the matching value submitted.

Toggle:

A toggle command is just like a selection, except there are guaranteedonly two values and they include an action label (future value). Forexample, a light switch may say “Turn On”. The moment it's pressed, theclient can switch to the other label, then submit the request. See FIG.27.

“someFlagBoolean”: { “action”: “blah”, “method”: “post”, “params”: {“state”: {  “type”: “toggle”,  “options”: [ { “value”: “on”, “label”:“Enabled”, “actionLabel”: “Disable” }, //toggles need an actionLabelwhich is action to take { “value”: “off”, “label”:“Disabled”, “actionLabel”: “Enable” }  ] }  }  }

Following is an example of sending a request to switch on the light:

Sample Command Request

POSThttp://host:port/mobile/rest/icontrol/ui/operations?action=/ui/client/lighting/lighting-0060350426ea-9/setOnOff&onOff=on

For toggles, the current value is the future state (the one we′d send).It should show the label for the current value, and the actionLabel forthe button (if used). While pending, we can show the other label afterwe submit (to indicate the future state).

Range:

A range command is typically drawn as a slider or stepper. It allows theuser to select from a wide range of numbers, such as brightness ortemperature. See FIG. 28.

“setpointCooling”: {“action”: “operations?method=POST&action=/ui/client/thermostat/thermostat-22/setPointCooling”, “method”: “post”, “label”: “Cool to”, “params”: { “setpointCooling”: { “type”: “range”, “min”: 35, “max”: 95, “step”: 1,“labels”: [ //optional, only need this if unique labels for certainvalues  { “value”: 0, “label”: “Off” }, //we may have specific labels touse for certain values  { “value”: “default”, “label”: “{0}&deg;” }//otherwise, we may need to format the number for display ],  } }  }

This command may not show the value as a number (such as a slider). Ifit does (such as a stepper), labels can be used for formatting. Notethat for percentages (where max=1) they should be multiplied by 100before display.

Text Input

This command is for inputting text, typically for naming things. Couldbe used for authentication if that UI is data driven. See FIG. 29.

“setDevName”: { “action”: “foo/bar/deviceName”, “method”: “post”,“label”: “Name:”, “params”: { “devName”: {  “type”: “textInput”, “regExp”: “[a-zA-Z0-9]?”, //must *match* this regExp before  submitting “minChars”: 4, //must have at least this # chars before  submitting“maxChars”: 16, //must have <= this # chars “defaultValue”: “”  } } }Controls—Building Blocks for Local UI Elements

Commands send messages to the server, and controls are for LOCAL UI.Even though they may not be part of the view model from the server, itbears mentioning these can be generated locally to simplify renderinglocal UI.

Typically, controls provide navigation. Since our navigation model isbased on hashcodes, they send those codes to the controller.

Navigation

“gotoLights”: { “type”: “navigation”,  //type of command. This onetypically  rendered as link or button “action”: “#lights”, //hashcode toappend to current URL “label”: “Lights”  }Singletons—the Top Level Objects

Client views can be described with these singleton objects:

-   -   1. site—atom that indicates the current site, and controls to        switch sites    -   2. summary—atom that indicates what orb to show, system summary        text, and sensor summary text    -   3. security—atom that includes stateful functions (buttons) to        show, and any arm protest or alarm dialog info to show    -   4. shift—atom that contains the current shift state, and        functions to change shifts [not pictured above]    -   5. messaging—atom that includes a list of any warnings [not        pictured in screenshot above], login msgs, and system messages    -   6. hvwSettings—atom for static home view data, includes labels        and device positions. Not expected to change much.

And these groups:

-   -   1. hvwData—atom that includes dynamic data such as device        states, updated whenever a device state changes.    -   2. sensors—group of sensor atoms    -   3. locks—group of lock atoms    -   4. lighting—group of switch atoms (typically lights)    -   5. thermos—group of thermostat atoms    -   6. energyMeters—group of atoms reporting power    -   7. cameras—group of camera atoms    -   8. otherDevs—array of list names (in order) used for Other        Devices lists        Site Object

The site object describes the current site and allows users to switchsites. It also provides info about the current user. See FIG. 30.

“site”: { “id”: “site”, “name”: “Sites”, “userName”: “Ken”,“isOwner”: true, “locale”: “en_US”, //THIS user's locale pref, which forTS is the site owner “serverVersion”: “5.5.0-1234”,“gatewayVersion”:“5.0.1-1234”, “state”: { “setSite”: “0060350312345”  }, “commands”: { “setSite”: { //if setSite cmd called, should get newstate with the new site. More importantly, request for “client” willgive ALL new objects.  “action”:“operations?method=POST&action=/ui/client/site/setSite”,  “method”:“post”,  “params”: { “site”: {  “type”: “select”,  “options”: [ {“value”: “00503503523AB”, “label”: “My Cabin” }, { “value”:“0060350312345”, “label”: “Ken's House” }, { “value”: “00503503523AB”,“label”: “The Smith Home” }  ] }  } }, “signOut”: {  “action”:“operations?method=POST&action=/ui/client/site/signOut”,  “method”:“post”,  “label”: “Sign Out” }  } }

//Example usage to get current site name:

var buttonLabel=site.commands.site.options[site.commands.state.setSit

The site object is functionally unique. If the user clicks a command torequest a different site, the entire view model will be replaced withinfo on the new site.

SOMEDAY: may want settings/style object that provides logo URL and othersite-brand specific settings.

Summary Object

See FIG. 31. This describes the orb or equivalent, and summary text thatmay be shown. If there is a security panel, it will include the securitystate.

 “summary”: {  “id”: “summary”,  “name”: “Security”, //If summary stuffshown in a tab (like mobile), this would be the tab's label.  “state”: {//Note that for a panel-less config, the name is “System”.“systemIcon”: “disarmed”, “numTrouble”: 0, “numOpen”: 1, “numMotion”: 0,“statusTxt”: “Disarmed.”, “sensorStatusTxt”: “1 Sensor Open.”, //Thisvalue is overloaded. Sometimes sensor status, but may show currentalarm. “delayEndTs”: 1268942401856 //ONLY SUPPORTED LOCALLY, NOT MOBILECLIENTS: set if we are in panel delay. Time is relative to ts above.  }}

NOTE: history for the summary object is what we refer to as “NotableEvents”. Please see the history spec for details of getting historygiven a client object id.

There are complex rules for the text provided, see the Cross ClientSensor Summary UI guidelines.

The delayEndTS attribute is set once if we've entered exit delay, and iscleared when exit delay completes. The end time will be relative to theis provided with this particular update. Exit delay countdown is handledlocally as the difference between the time the delta was received(matched to the update time) and the end time.

Possible values for “statusTxt” include (from SummaryPage.javagetOrbSecuritySummaryTextHTML( ) and UX-Spec-Sensor_States.doc):

-   -   “Status Unavailable”    -   “Armed All”, “Armed Stay”, “Armed Away”, “Disarmed”, “Armed        Maximum”, “Armed Night-Stay”, “Armed Away Instant”, “Armed        Motion”, “Subdisarmed”.    -   There may be appended to any of these “No Exit Delay”. As in        “Armed Stay, No Exit Delay”.

Possible values for “sensorStatusTxt” include (from SummaryPage.javagetOrbSensorSummaryText( ) and UX-Spec-Sensor_States.doc):

-   -   If in an alarm: “Burglary Alarm”, “Fire Alarm”, “Carbon Monoxide        Alarm”, “Audible Panic Alarm”, “Tamper Alarm”, “Freeze Alarm”,        “Personal Emergency Alarm”, “Exit Fault Alarm”, “Water Alarm”,        “Silent Panic Alarm”, “Duress Alarm”, “Temperature Alarm”,        “Waterflow Alarm”, “Gas Alarm”, “General Alarm” (note, these        status text overrides are not in the current UX spec, but all        clients use this convention)    -   “Uncleared Alarm”, “Sensor Tripped”, “Sensors Tripped”, “Sensor        Problem”, “Sensors Problem”, “Sensor Bypassed”, “Sensors        Bypassed”,    -   [# of sensors open] Sensor(s) Open,    -   “Motion”, “All Quiet”

Possible values for “systemlcon” include (from SummaryPage.javagetOrbImage( ):

-   -   “offline”, “alarm”, “armed”, “disarmed”

Possible values for num* are integers>=0.

Security Object

See FIG. 32. The security object holds the security commands to arm anddisarm. Note that some security info is also reflected in the SUMMARYobject. Typically a security change alters both the security and thesummary object.

“security”: {  “id”:    “security”,  “state”: {   “label”:    “Arm”, //this is the label for the primary button (not present in portal)  “disabled”:    false,  //if primary button is disabled   “busy”:   false,  //if primary button is busy, such as during ECP connection  “protestList”:  [ ]   //If panel is in arm-protest, client may show amessage and list these issues (see below)  },        //Note thatstate/protestList may not exist (null is the same as [ ])  “items”: [ //items with commands are only available if iHub & panel is in OK state/ online   {   “label”: “Arm All”,   “commands”: {    “panelAction”: {   “action”:“operations?method=POST&action=/ui/client/security/setArmState?armState=Away”,   “method”: “post”    “busyStatusTxt”: “Arming...”    }   }   },   {  “label”: “Doors & Windows”,   “commands”: {    “panelAction”: {   “action”:“operations?method=POST&action=/ui/client/security/setArmState?armState=Stay”,    “method”: “post”     “busyStatusTxt”: “Arming...”    }    }   }   ] }

The security object describes arming controls. Most clients show asummary button which is a local navigation that presents the actualarm/disarm/clear buttons. There is a complex state flow for thesebuttons.

There's a special rule for these items. If there's only one, then thetop level button will submit that command. For example, if the only itemis Disarm we effectively duplicate the labels at the top level, butclicking it will auto-submit the command of the first item.

A Typical Arming Sequence:

-   -   1. User clicks top level “Arm” button. Note that        summary.statusTxt==“Disarmed”.    -   2. Dialog popups up with list of arm buttons. User clicks “Arm        Away” button and sends its command.    -   3. Dialog closes. Local controller changes top-level Arm button        to busy+disabled        (security.state.busy=true+security.state.disabled=true), and        uses busyStatusTxt value “Arming” as new button label.    -   4. Command is sent (action submitted to server).    -   5. New Security object is returned from server, with the primary        button busy+disabled, and the label is now “Arming” (Or        “Disarming” or “Clearing”), no items.    -   6. After the panel has be reached and change occurs . . .    -   7. New Security object is returned, primary button now active        and label is “Disarm”. The only item is disarm item+command.    -   8. commandResponse delta is received with success code    -   9. New Summary object is returned, summary.statusTxt==“Armed        Away”, and systemIcon==“armed” (so orb is now red).        Remote Clients Local Client (Touch Screen)        What if the Arming Fails?

Here's what happens after step 5:

-   -   1. A new Security object is returned which overwrites local        changes.    -   2. If the command failed, a commandResponse delta update is sent        by the server. See that section in this spec.    -   3. In response to commandResponse, client may popup up a dialog        and displays the error, such as “Arm failed. PIN value is        incorrect.”        What if there is an Arm Protest?

If there are open zones that cannot be bypassed, that is handled as anarm failure (see commandResponse). However, for normal panel protestswe'll get a protest list which is shown to the user:

-   -   1. User clicks top level “Arm” button. Note that        summary.state.statusTxt=“Disarmed”.    -   2. Dialog popups up with list of arm buttons. User clicks “Arm        Away” button.    -   3. Command is sent (action?value=away) to server.    -   4. New Security object in protest mode is returned, which        overwrites local changes and has NEW items:

“security”: {  “id”:    “security”,  “state”: {   “label”:  “Arm”,  “disabled”: false,   “busy”:  false,   “protestList”: [“Back Door -Open”] //a list of panel and zone protest strings to show  },  “items”:[   {  //there may be cases where panel cannot arm due to a protest; inthat case this command is omitted   “label”: “Arm Anyway”,   “commands”:{    “panelAction”: {    “action”:“operations?method=POST&action=/ui/client/security/setForceArm&arm=Away”,    “method”: “post”,    “busyStatusTxt”:“Arming...”    }   }   },   {   “label”: “Cancel”,   “commands”: {   “panelAction”: {    “action”:“operations?method=POST&action=/ui/client/ security/setCancelProtest”,   “method”: “post”,    “busyStatusTxt”: “Canceling...”    }   }   }  ] }

This is typically handled as a dialog. Note: it should be sent to ALLclients with active sessions. For example, if you click Arm on youriPhone then walk toward your door, your TS may show the protest dialog.Clearing it on any client will clear the dialog on all because the modelwill change as described.

What if we Require PIN to Disarm (Only on Touch Screen)?

If PIN code is required, the disarm item will have params:

-   -   1. User clicks top level “Disarm” button. Note that        summary.statusTxt=“Armed Away” or other.    -   2. Because params are required, Dialog popups up with prompt for        PIN code, user clicks Ok button to submit.    -   3. Dialog closes. Local controller changes Disarm button to        busy+disabled        (security.state.busy=true+security.state.disabled=true).    -   4. Command is sent (e.g. action?value=disarm&pin=1234) to        server.    -   5. New Security object is returned from server, with the primary        button busy+disabled, and the label is now “Disarming”.    -   6. After the panel has been reached and change occurs . . .    -   7. New Security object is returned, primary button now active        and label is “Arm”, and new items includes arm buttons.    -   8. commandResponse delta is received with success code    -   9. New Summary object is returned,        summary.statusTxt==“Disarmed”, and systemIcon==“disarmed” (so        orb is now green).

“security”: {  “id”:    “security”,  “state”: {   “label”:  “Disarm”,  “disabled”: false,   “busy”:  false,  },  “items”: [   {   “label”:“Disarm”,   “commands”: {    “panelAction”: {    “action”:“operations?method=POST&action=/ui/client/security/setArmState?arm=disarm”,    “method”:  “post”,    “busyStatusTxt”:“Disarming...”    “params”: {     “pin”: {     “type”:   “textInput”,    “regExp”:   “[0-9]?”,     “minChars”:  4,     “maxChars”:  8,    “defaultValue”: “”     }    }    }   }   }  ]  }What if we Require a PIN to Arm (if Panel Quickarm==False, Also Only onTouch Screen)?

If a PIN is required, biz layer will add a pin param to the command foreach arming button:

“security”: {  “id”:    “security”,  “state”: {   “label”:  “Arm”,  “disabled”: false,   “busy”:   false,  },  “items”: [   {   “label”:“Arm Stay”,   “commands”: {    “panelAction”: {    “action”:“operations?method=POST&action=/ui/client/security/setArmState?arm=Arm%20Stay”,    “method”:  “post”,    “busyStatusTxt”:“Arming...”    “params”: {     “pin”: {     “type”:   “textInput”,    “regExp”:   “[0-9]?”,     “minChars”:  4,     “maxChars”:  8,    “defaultValue”: “”     }    }    }   }   },   {   “label”: “ArmAway”,   “commands”: {    “panelAction”: {    “action”:“operations?method=POST&action=/ui/client/security/setArmState?arm=Arm%20Away”,    “method”: “post”,    “busyStatusTxt”:“Arming...”    “params”: {     “pin”: {     “type”: “textInput”,    “regExp”: “[0-9]?”,     “minChars”: 4,     “maxChars”: 8,    “defaultValue”: “”     }    }    }   }   }  ]  }What if we have Options for No Entry Delay, or Silent Exit (Only onTouch Screen)?

For these options (typically shown on the touch screen), params will beadded to the command for each arming button:

“security”: {  “id”:    “security”,  “state”: {   “label”:  “Arm”,  “disabled”: false,   “busy”:  false,   “noEntryDelay”: “1”,  “silentExit” : “1”  },  “items”: [   {   “label”: “Arm Stay”,  “commands”: {    “panelArm”: {    “action”:“operations?method=POST&action=/ui/client/security/setArmState?arm=Arm%20Stay”,    “method”:  “post”,    “busyStatusTxt”:“Arming...”    “params”: {     “noEntryDelay”: {     “type”: “toggle”,    “options”: [      { “value”: “1”, “label”: “No Entry Delay”,“actionLabel”:      “Entry Delay”  },      { “value”: “0”, “label”:“Entry Delay”,  “actionLabel”:      “No Entry Delay” }     ]     },    “silentExit”: {     “type”: “toggle”,     “options”: [      {“value”: “1”, “label”: “No Silent Exit”, “actionLabel”:      “SilentExit”  },      { “value”: “0”, “label”: “Silent Exit”,  “actionLabel”:     “No Silent Exit” }     ]     }    }    }   }   },   {   “label”:“Arm Away”,   ...   }  ]  }What if We'Re in Entry Delay, and Need to Prompt for PIN (Only on TouchScreen)?

This case is no different than if the user tapped the Disarm button insection 5.3.4, except the client effectively taps it for them. When asystem is Armed Away and the user opens a door, the client will get anew summary object with a countdown, and a new security object with onlythe Disarm command. In addition, it has a new state property“autoRunItem” with an item index. As soon as the client gets this newobject with autoRunItem, it automatically executes that command as ifthe user pressed that button.

“summary”: {  “id”:    “summary”,  “name”:   “Security”,  “state”: {  “systemIcon”:  “armed”,   “numTrouble”:  0,   “numOpen”:   1,  “numMotion”:  0,   “statusTxt”:  “Armed Away.”,   “sensorStatusTxt”:“All Quiet.”,   “delayEndTs”:  1268942437235  //IMPORTANT:   ifnon-zero, TS shows is showing entry           //delay. In that case, isas if user tapped the main           //security button.  } },“security”: {  “id”: “security”,  “state”: {   “label”:   “Disarm”,  “disabled”:  false,   “busy”:   false,   “autoRunItem”: 0   //indexinto items array. Ignore if −1 or empty  },  “items”: [   {   “label”:“Disarm”,   “commands”: {    “panelAction”: {    “action”:“operations?method=POST&action=/ui/client/security/setArmState?arm=disarm”,    “method”:  “post”,    “busyStatusTxt”:“Disarming...”    “params”: {     “pin”: {     “type”:   “textInput”,    “regExp”:   “[0-9]?”,     “minChars”:  4,     “maxChars”:  8,    “defaultValue”: “”     }    }    }   }   }  ]  }Shift Object

See FIG. 33. Like the arm button, the main shift button has a label andsettings, and invokes a select list of shifts.

“shift”: {  “id”:   “shift”,  “name”:  “Modes”,  “state”: {   “label”: “Vacation”,   “disabled”: false,   “busy”:  false,  “pendingShiftMode”: “shiftModes/shiftName2”   },  “commands”: {  “setShiftMode”: {   “action”: “operations?method=POST&action=/ui/client/shift/  setCurrentShiftMode”,   “method”:  “post”,   “params”: {   “pendingShiftMode”: {    “type”: “select”,    “options”: [     {“value”: “shiftModes/shiftName1”, “label”: “At Home”  },     { “value”:“shiftModes/shiftName2”, “label”: “Vacation” },     ...    ]    }   }  }  }  }

Note that the top label is used just for a local button to invoke thelist of commands.

FYI: this correlates to the correct iHub function for setting shift:

-   -   <function name=“Set    -   Points”        method=“POST”mediaType=“instance/config”action=“/rest/icontrol/nw/319125nt00057/instances/2.shiftArmingLinkage/points”>        -   <input name=“pendingShiftMode” type=“select”required=“false”            mediaType=“shift/pendingShiftMode”>            -   <option selected=“true”/>            -   <option>shiftModes/shiftName1</option>            -   <option>shiftModes/shiftName2</option>            -   <option>shiftModes/shiftName3</option>            -   <option>shiftModes/shiftName4</option>            -   <option>shiftModes/shiftName5</option>            -   <option>shiftModes/shiftName6</option>            -   <option>shiftModes/shiftName7</option>            -   <option>shiftModes/shiftName8</option>        -   </input>    -   </function>

If the user has never seen shift before, they'll get a different label,and a command to clear. This sets a ppref and clears it for that userfor all sites and all clients. They can also click Cancel (or X orwhatever the design is) and dismiss the command dialog.

“shift”: {  “id”:   “shift”,  “name”:  “Modes”,  “state”: {   “label”: “Modes”,   “disabled”: false,   “busy”:  false,   “pendingShiftMode”:“”    },   “commands”: {   “hasSeenShiftHelp”: {    “label”: “OK”,   “action”: “site/foo/bar/hasSeenShiftHelp”, //rest URL to submitaction (may be appended to a base URI)    “method”: “post”,   “statusTxt”: “Welcome to Modes!/nAutomate your home with one click.To get started, visit System > Modes in the web portal.”   }   }  }Messaging Object

See FIG. 34. There are only a few types of messages that are presentedin the UI.

-   -   Dismissible messages—shown to the user, then dismissed forever        (either by clicking, or timeout). E.g. last sign in.    -   Non-dismissable messages—shown to the user. They can be hidden        and revisited later, but they don't go away until the state has        changed. E.g. panel low battery.

The other vector for messages is the severity. Initially there are 2levels of severity

-   -   Info messages—just information, not a problem or warning. E.g.        last sign in, or connecting message.    -   Warning messages—an error, problem, or warning: signin failure        (dismissable), panel problem etc.    -   Alarm messages—an alarm, general shown in a modal dialog over        all else (usually dismissible)

This messaging object is global. It's about the general system and thesecurity panel. Initially it's a short list:

-   -   panel warnings—low battery, ac loss, comm failure, and panel        troubles    -   login failure warning or last login info    -   command failure messages—couldn't turn off a light etc.

The messaging object is not meant for sub-components of the system, suchas a camera offline. Messaging for sub-components are handled withinthose tabs, such as waiting/loading boxes and spinners. Offline panel isalready handled by the orb+summary text. And alarms and other stuff maybe shown in dialogs.

Login Message

This message is dismissable, so the client needs to track when it's beenviewed and dismissed. Typically it will also be set to auto-dismissafter a few seconds.

For example, if message type “info” is “Last sign in: May 30, 2012 734PM”, with dismissAfterSeconds=5 it would look like this.

“messaging”: {  “id”:   “messaging”,  “items”: [   {   “type”: “info”,  “isDismissable”: true,   “icon”: “devStatOK”, //note - client willprobably not show this icon   “statusTxt”: “Last sign in: May 30, 2012734 PM”,   “dismissAfterSeconds”: 5 //−1 is the default - it means showforever (same if prop doesn't exist)   }  ]  }

Once the render knows it has been shown to the user, a timer counts downfrom 5. Once 5 seconds has passed (or user clicks message to dismiss,whichever is sooner), the local message item will be deleted. If theuser refreshes their browser, it would probably be shown again because afull delta snapshot would get this item again from the render-ready API.

Here are the Possible “Icon” Values for Messages:

“devStatOK”, “devStatOffline”, “devStatInstalling”, “devStatTamper”,“devStatLowBatt”

Partial List of “statusTxt” Values:

-   -   “Security Panel Low Battery”    -   “Broadband Connection—Unknown”, “Not Connected for Remote        Control”, “Connecting for Remote Control . . . ”    -   “Cellular Connection—Unknown”, “No Cellular Connection”, “Using        Cellular Connection”, “Cellular Backup Connection Available”    -   “RF Jam Detected”, “AC Power Failure”, “Low Battery”, “Tamper”        Clearable Panel Warnings (Only Supported on Touch Screen)

For the TS (and preferably all clients) we need a way to clear certainpanel warnings, so a command may be added. In that case, a warning itemmay have a clearWarning command to show a Clear button.

“messaging”: {  “id”:   “messaging”,  “items”: [   {   “type”:  “warning”,   “isDismissable”: false,   “icon”:   “devStatOffline”,  “statusTxt”:  “Security Panel Low Battery”,   “timeTxt”:  “”,//ignored for most warnings   “dismissAfterSeconds”: −1,   },   {  “type”:   “warning”,   “isDismissable”: false,   “icon”:  “devStatOffline”,   “statusTxt”:  “Security Panel CommunicationsFailure”,   “dismissAfterSeconds”: −1,   “commands”: {   “clearWarning”: {    “label”: “Clear”,    “action”:“site/foo/bar/clearWarnings”, //rest URL to submit action (may beappended to a base URI)    “method”: “post”    }   }   }  ]  }Alarm Messages (Note: Today, Portal Only Shows 1 Alarm at a Time)

If there's a security alarm, that message is type Alarm. Ifs usually notdismissible (only shown once per session) and shown in a modal dialog.It may be a list (client should split on commas and show on separatelines).

Note for TS design: that alarm dialog also will show the primarysecurity button on it. So that alarm dialog will have a Disarm button,or ARM/Disarm, or Clear Alarm—whatever is in security.state.label, andclicking it does whatever that command would do (including showing thesame prompt-for-PIN dialog seen in entry delay).

“messaging”: {  “id”:   “messaging”,  “items”: [   {   “type”:  “alarm”,   “isDismissable”: false,   “icon”:   “devStatAlarm”,  “statusTxt”:  “Burglary Alarm, Zone 5”,   “timeTxt”:  “9:26 AM”,//generally get this column for message   type alarm  “dismissAfterSeconds”: −1 //−1 is the default - it means show forever(same if prop doesn't exist)   },   {   “type”:   “alarm”,  “isDismissable”: false,   “icon”:   “devStatAlarm”,   “statusTxt”: “Fire Alarm, Zone 1”,   “timeTxt”:   “9:28 AM”,  “dismissAfterSeconds”:−1 //−1 is the default - it means show forever (same if prop doesn'texist)   }  ]  }Home View Settings Object

See FIG. 35. The hvwSettings object provides the base home view datathat comes from a home view editor: location of walls, labels, anddevice position. Note that device states are dynamic and provided by aseparate object, hvwData described later.

“hvwSettings”:  {   “id”:  “hvwSettings”,   “name”:  “Home View”,  “state”: {   “show”:  true,          //check ppref homeview/portal(portal||mobileAndroid||iphone) if enabled for client   “floors”:“28;tlakjslkajsdflkajsdflkaldsfkjalsdkfjals”, //ppref hvw/floors: dataneeded to render each floor.   “labels”: “wer‘Living Room’ouk‘Bedroom’”,    //ppref hvw/labels: data needed for all labels  “devices”: “oiu12 oboSC0FEBEF wer26”      //ppref hvw/devices: datafor device locations on floors   },   “commands”: {   “showHomeview”: {   “action”: “foo/bar/showHomeView=true”,  //values are true or false   “method”: “post”,    “label”: “Turn On”  //values are Turn On or TurnOff   }   }  }Group: Home View Data

See FIG. 36. The hvwData object provides a list of device data thatoverlays a floor plan. It is similar to the other device groups, exceptthat some state values are unique (compound statusTxt, floatTxt forthermos etc.).

“hvwData”: {   “id”:  “hvwData”,   “items”: [   {       // First device  “id”:   “hvwData-34”,   “devIndex”: “34VER1”, //deprecated deviceindex provided by server. Generally, the LAST 6 digits of UniqueID,unless more #s to left   “name”:  “Front Door”,   “tags”:  “sensor”,  //Values: “sensor”   “state”: {    “icon”:   “devStatOpen”,  //can be anyicon a “sensor” item supports, including devStatLowBatt, devStatOffline,devStatInstalling etc.    “statusTxt”:  “Front Door - Open\nLast Event:Yesterday, 2:36 PM”, //shown if mouse is over the icon. May be 2 or 3lines.   }   },   {      // 2nd device   “id”:   “hvwData-22”,  “devIndex”: “22”,   “name”:  “Downstairs Thermostat”,   “tags”: “zw,thermostat”,  // Values: “zw”=indicates a ZW device; “thermostat” =for thermostats   “state”: {    “icon”:  “devStatThermoOn”, //any icondevice type supports, & may be devStatLowBatt, busy, or devStatAlarm(for gar door stopped)    “statusTxt”: “Downstairs Thermostat - Cooling,78&deg;”,    “floatTxt”: “78&deg;”  //currently, only thermos have floattext: temperature   }   }  ]  }Group: Sensor

 “sensor”: {  “id”: “sensor”,  “name”: “Sensors”,  “items”: [  {      // First sensor   “id”: “sensor-34”,   “devIndex”: 34,  “zone”: 9,   “name”:  “Front Door”,   “tags”:  “sensor”,  // Values:“sensor”   “state”: {    “icon”:  “devStatOpen”,    “statusTxt”: “Open”,   “lastEvent”: “Yesterday, 2:47pm”,    “sort”:  50,  //Sort order 50-90are “interesting” sensors (may be separated). 0-40 are “quiet”   “bypassed”: false   },   “commands”: {    “bypassedBoolean”: { //onlyavail on TS, this command allows    user to bypass this sensor   “label”: “Bypass”, //label for the action button    “action”:“operations?method=POST&action=ui/client/sensors/sensor-34/bypassed&value=1”,    “method”: “POST”,    “params”: {    “pin”: { //Note: PIN can be held in memory for 30 seconds, so ifuser bypasses a 2nd zone, we should reuse PIN (no prompt)     “type”:  “textInput”,     “regExp”:  “[0-9]?”,     “minChars”:  4,    “maxChars”:  8,     “defaultValue”: “”    }    }    }    }   },  {     // 2nd sensor    “id”:  “sensor-35”,    “devIndex”: 35,   “name”:  “CO2 Detector”,    “tags”:  “sensor”,    “state”: {   “icon”:  “devStatOk”,    “statusTxt”: “Bypassed, Okay”,    “sort”: 0,   “bypassed”: true   },   “commands”: {    “bypassedBoolean”: { //onlyavail on TS, this command allows    user to bypass this sensor   “label”: “Unbypass”,    “action”:“operations?method=POST&action=/ui/client/sensors/sensor-35/bypassed&value=0”,    “method”: “POST”,    “params”: {    “pin”: {     “type”:   “textInput”,     “regExp”:  “[0-9]?”,    “minChars”:  4,     “maxChars”:  8,     “defaultValue”: “”     }   }    }   }  }  ] }List of Possible Sensor “State”'s “statusTxt” (fromUX-Spec-Sensor_States.Doc):

-   -   ALARM, [Sensor state], “ALARM”    -   “Tripped”    -   Tampered, [Sensor state]    -   Trouble, [Sensor state]    -   Low Battery, [Sensor state]    -   “Offline”    -   “Unknown”    -   “Installing”    -   [Sensor state]    -   Bypassed, [Sensor state]        List of Possible [Sensor State] Values:    -   “Open”, “Closed” (for doors, windows)    -   “Motion”, “No motion” (for motion sensors only)    -   “Tripped”, “Okay”        List of Possible Sensor “State”'s “Icon” (from SummaryPage.java        sensorStateIcon( )):    -   “devStatOK”, “devStatUnknown”, “devStatOffline”,        “devStatInstalling”, “devStatAlarm”, “devStatTamper”,        “devStatLowBatt”, “devStatOpen”, “devStatMotion”        Device State Property Overview

Here are the elements for each of the main z-wave & camera device stateobjects:

State door/ door/ Property doorLock barrier lighting thermostat cameraenergyMeter icon devStatUnknown devStatUnknown devStatUnknowndevStatUnknown devStatUnknown devStatUnknown devStatOfflinedevStatOffline devStatOffline devStatOffline devStatOfflinedevStatOffline devStatInstalling devStatInstalling devStatInstallingdevStatInstalling devStatInstalling devStatInstalling devStatUnlockeddevStatGarageOpen devStatLightOn devStatThermoOn devStatOKcameradevStatEnergyWHMOn devStatOKlock devStatOKgarage devStatOKlightdevStatOKthermo devStatOKenergyWHM devStatEnergyOn devStatOKenergy busytrue||false true||false true||false true||false — — (boolean) statusTxtUnknown Unknown Unknown Unknown Unknown Unknown (summary, OfflineOffline Offline Offline Offline Offline used for Installing InstallingInstalling Installing Installing Installing lists) Locked Open Off 76°12 w Unlocked Closed On Cooling, 76° Low Battery, Stopped 50% (10%, . .. , Heating, 76° Locked Opening . . . 100%) Adjusting . . . Low Battery,Closing . . . 10 w, On Changing Unlocked 10 w, 50% Mode . . . Locking .. . Turning On . . . Changing Unlocking . . . Turning Off . . . Fan . .. Changing . . . activityTxt Locking . . . Opening . . . Turning On . .. Cooling — — Unlocking . . . Closing . . . Turning Off . . . HeatingChanging . . . Adjusting . . . (for % chg) Changing Mode . . . ChangingFan . . . troubleTxt Unknown Unknown Unknown Unknown Unknown UnknownOffline Offline Offline Offline Offline Offline Installing InstallingInstalling Installing Installing Installing Low Battery Stopped LowBattery detailTxt — — 10 26° — 12 shortUnitTxt — — w C — w longUnitTxt —— watts Celsius — watts level — — 0.5 26.0 — 12.0 (raw floats (% ifdimmer (raw watts) to drive 0-1) UI) setpointCooling — — — 75.0 — —setpointHeating — — — 62.0 — — thermostat — — — auto (some — — Modedevs) heat aux heat (some) cool off thermostat — — — auto — — FanMode onGroup: Door

This is now a combined group, with both door locks and garagedoor/barrier controllers in the same top-level object. They can bedistinguished by the tag values. See Garage Door spec for details on GDOstates and flows.

“door”: {  “id”:   “door”,  “name”:  “Doors”,   //This is typically thename of the tab (and the title - ignore screenshots)   “icon”: “symDoors”,  “numTrouble”: 0,  “items”: [   {   //FIRST LOCK    “id”: “door-27”,    “devIndex”: 27,    “name”:  “Lock: Front Door”,   “tags”:  “doorlock,zw”, // Values: “zw”=ZW device; “doorlock”=fordoorlock types; “barrier”=for GDOs    “state”: {   “icon”: “devStatUnlocked”, //devStatOKlock, devStatUnknown, devStatOffline,devStatInstalling   “statusTxt”: “Unlocked”,  //for list view: Locked ||Unlocked. May INCLUDE low battery, as in “Low Battery, Locked”  “activityTxt”: “”,   //while command being processed, may be“Locking...” or “Unlocking...”   “troubleTxt”: “Low Battery”,  //may beUnknown, Offline, Installing, Low Battery   “busy”:  false   //true ifprocessing a command    },    “commands”: { //commands only available ifdevice is in OK state (not Unknown, Offline, or Installing)  “lockBoolean”: {    “action”: “operations?method=POST&action=/ui/client/doorLock/doorLock-27/setLock&value=0”, //other action is value=1    “method”:  “post”,   “label”:   “Lock”,    “busyStatusTxt”: “Locking...”,    “busyIcon”: “devStatOKlock”,    “timeoutSecs”: 30 //after sending this action, setbusy+disabled for up to this long   }  }  },  {  //FIRST Garage Door  “id”:  “door-29”,   “devIndex”: 29,   “name”:  “My Garage Door”,  “tags”:  “barrier,zw”, // Values: “zw”=ZW device; “doorlock”=fordoorlock types; “barrier”=for GDOs   “state”: {   “icon”: “devStatGarageOpen”, //devStatOKgarage, devStatUnknown, devStatOffline,devStatInstalling   “statusTxt”: “Open”,  //Open, Closed, Stopped,Unknown, Offline, Installing   “activityTxt”: “”,  //while command beingprocessed, may be “Opening...” or “Closing...”   “troubleTxt”:“Stopped”, //normally empty, but may indicate Stopped   “busy”:  false //true if processing a command   },   “commands”: { //commands onlyavailable if device is in OK state (not Unknown, Offline, or Installing)  “garageBoolean”: {    “label”:  “Close”,    “action”: “operations?method=POST&action=/ui/client/garageDoor/garageDoor-20&value=0”, //other action is /unlock    “method”:  “post”,   “busyStatusTxt”: “Closing...”,    “busyIcon”:  “devStatOKgarage”,   “timeoutSecs”: 30 //after sending this action, set busy+disabled forup to this long   }   }  },  { ... }  ] }Group: Lighting

See FIGS. 37A and 37B.

“lighting”: {  “id”:   “lighting”,  “name”:  “Lights”,  “numTrouble”: 0, “icon”:  “symLights”, //this is summary icon for ALL lights (currentlyOFF)  “items”: [   { //START OF 1st light   “id”:  “lighting-17”,  “devIndex”: 17,   “name”:  “Hallway Dimmer”,   “tags”: “lighting,dimmer,zw”, // Values: “zw”=ZW device; “lighting”=lightingdevice; either “dimmer” or “switch” depending on the type   “state”: {   “icon”: “devStatOKlight”, // devStatLightOn, devStatUnknown,devStatOffline, devStatInstalling    “statusTxt”: “Off”, //“On”, “50%”,“15 w, On”, “42 w, 80%”    “activityTxt”: “”, //while command beingprocessed, may be “Turning On...”, “Turning Off...”, “Changing...” (ifdimmer change)    “troubleTxt”: “”, //“”, “Unknown”, “Offline”,“Installing”    “detailTxt”: “”,  //if energy device and non-zero: rawtext for rendered energy, such as “15”    “shortUnitTxt”: “”” //ifenergy device and non-zero: short unit text “w” for watts, “kW” forkilowatts    “longUnitTxt”: “”” //if energy device and non-zero: longunit text “watts” or “kilowatts”    “busy”:  false, //true if processinga command    “level”:  0  //for dimmers, dim percentage as float between0 and 1, such as 0.3   },   “commands”: { //commands only available ifdevice is in OK state (not Unknown, Offline, or Installing)   “lightBoolean”: { //this command available for ALL switches anddimmers    “action”:“operations?method=POST&action=/ui/client/lighting/lighting-319125nt00057-22/setOnOff&onOrOff=1”, //=0 for off    “method”: “post”,   “label”: “Turn On”,    “busyStatusTxt”: “Turning On...”,   “busyIcon”:  “devStatLightOn”    },    “lightDimmer”: { //thiscommand only provided if dimmer    “action”:“operations?method=POST&action=/ui/client/lighting/lighting-319125nt00057-22/setDimmer”,    “method”: “post”,    “busyStatusTxt”:“Adjusting...”,    “busyIcon”: “devStatLightOn”,    “params”: {    “level”: {      “type”: “range”,      “min”: 0,      “max”: 100,     “step”: 10      “labels”: [      { “value”: “default”, “label”:“{0}%” }      ]     }    },     }    }   }, //END OF 1st light  { ...2nd light ... }  ] }Group: Thermostat

See FIG. 38.

   “thermostat”: {     “id”: “thermostat”,     “name”: “Thermostats”,    “numTrouble”: 0,     “icon”: “symThermostats”, //this is summaryicon for ALL thermostats     “statusTxt”: “75&deg;”, //this is summarytext for ALL thermostats, typically the last- visited (might be localvalue?)     “items”: [      { //START OF 1st thermostat       “id”:“thermostat-22”,       “devIndex”: 22,       “name”: “DownstairsThermostat”,       “tags”: “thermostat,zw”, // Values: “zw”=ZW device;“thermostat”=for thermostats       “state”: {        “icon”:“devStatThermoOn”,// devStatThermoOn, devStatOKthermo, devStatUnknown,devStatOffline, devStatInstalling        “statusTxt”: “Heating, 71°”,       “activityTxt”: “”, //“Cooling”, “Heating”. During command:“Adjusting...” (setpoint chg), “Changing Mode...”, “Changing Fan...”       “troubleTxt”: “Low Battery”, //normally empty, but may indicatelow batt for bat- stats        “detailTxt”: “”, //raw text for renderedtemperature, such as “71°”        “shortUnitTxt”: “““ //short unit fordetail text: “C” for Celsius, “F” for Fahrenheit        “longUnitTxt”:“““ //long unit for detail text: “Celsius” or “Fahrenheit”      “level”: 72.0, //raw value as float, for analog renderers (needle,etc)  “thermostatMode”: “auto”, //these are values bound to commandsbelow       “thermostatFanMode”: “auto”,       “setpointCooling”: 71.0,      “setpointHeating”: 68.0,  “busy”: false //true if processing acommand     },     “commands”: { //commands only available if device isin OK state (not Unknown, Offline, or Installing)      “thermostatMode”:{       “action”:“operations?method=POST&action=/ui/client/thermostat/thermostat-22/setMode”,       “method”: “post”,       “busyStatusTxt”: “ChangingMode...”,       “params”: {        “mode”: {         “type”: “select”,        “options”: [          { “value”: “auto”, “label”: “Auto” }         { “value”: “heat”, “label”: “Heat” },          { “value”: “auxheat”, “label”: “Aux Heat” },          { “value”: “cool”, “label”:“Cool” },          { “value”: “off”, “label”: “Off” }         ]        }      }      },      “thermostatFanMode”: {       “action”:“operations?method=POST&action=/ui/client/thermostat/thermostat-22/setFanMode”,       “method”: “post”,       “busyStatusTxt”: “ChangingFan...”,       “params”: {        “fanMode”: {         “type”: “select”,        “options”: [          { “value”: “auto”, “label”: “Auto” },         { “value”: “on”, “label”: “On” }         ]        }       }     },      “setpointHeating”: {       “action”:“operations?method=POST&action=/ui/client/thermostat/thermostat-22/setPointHeating”,       “method”: “post”,       “busyStatusTxt”:“Adjusting...”,       “prefixTxt”: “Heat To”,       “params”: {       “setpointHeating”: {         “type”: “range”,         “min”:35.0,         “max”: 95.0,         “step”: 1.0,         “labels”:[{“value”: “default”, “label”: “ {0}&deg;” }]        }       }      },     “setpointCooling”: {       “action”:“operations?method=POST&action=/ui/client/thermostat/thermostat-22/setPointCooling”,      “method”: “post”,      “busyStatusTxt”:“Adjusting...”,      “prefixTxt”: “Cool To”,      “params”: {      “setpointCooling”: {        “type”: “range”,        “min”: 0.0,       “max”: 98.0,        “step”: 1.0,        “labels”: [{ “value”:“default”, “label”: “{0}&deg;” }]       }      }     }    }   },//END OF1st THERMOSTAT   { ... 2nd THERMOSTAT ... }  ] }

//Example update if 1st thermostat fan mode is turned on (to merge intoabove view):

“update”: {  “type”: “merge”,  “id”: “thermostat-22”,  “data”: { “state”: {   “setFanMode”: “on”  }  }Group: Camera

See FIG. 39.

Each camera type has certain capabilities, a limited set of “channels”(2, 3 or 4), and each channel is configured a certain way. For example,channel 2 may be configured to stream h.264-encoded video over an RTSPstream, with a default size of VGA and a max bitrate of 1000 kb.

Only the client knows what it can handle (rtsp or mjpeg? h.264 ormpeg?), and what size it wants to display (4-up might be QVGA, 1-upmight be VGA). So for each camera, the client can look at thecapabilities for each channel, select one, then request a URL for thatchannel.

The client will need to remember what it requested. For example, if yourequest channel 3, remember it will be a stream intended for QVGAdisplay.

“camera”: {  “id”:   “camera”,  “name”:  “Cameras”, //used as displayname for tab or widget  “numTrouble”: 0,  “icon”:  “symCameras”, //thisis summary icon for ALL cameras  “items”: [  { //FIRST CAMERA   “id”: “camera-33”,   “devIndex”: 33,   “name”:  “Living Room Camera”,  “tags”:  “camera,ip”, // Values: “ip”=for ip devices; “camera”=forcameras   “clipChannel”: 1,   “state”: {   “icon”:   “devStatOKcamera”,// devStatUnknown, devStatOffline, devStatInstalling   “statusTxt”:  “”,  “liveVideoURLs”: [ //these get populated/updated if thegetLiveVideoURL command is called. Here we got ch 2 only.    {“channel”: 1, “URL”: “” },    { “channel”: 2, “URL”: “https://relay2-aristotledev.icontrol.com:443/video/8fdb/image.mjpeg?size=large” },    {“channel”: 3, “URL”: “” }   ]   },   “commands”: { //commands onlyavailable if device is in OK state (not Unknown, Offline, or Installing)  “getLiveVideoURL”: { //client selects a channel (based on clientabilities) and request a URL (may be local or relay)    “action”:“operations?method=POST&action=/ui/client/camera/camera-130429zb866913-304/newVideoStream”,    “method”: “post”,    “params”: {     “channel”:{    “type”: “select”,    “options”: [ //possible codec vals: flv-h264,rtspHttps-mpeg, rtspHttps-h264, rtspUdp- mpeg, rtspUdp-h264, https-mjpeg    { “value”: 1, codec:“rtspHttps-mpeg”, “maxWidth”:640,“maxHeight”:320, “maxBitrateKb”:256, “audio”:“” },     { “value”: 2,codec:“https-mjpeg”, “maxWidth”:640, “maxHeight”:320, “maxBitrateKb”:512“audio”:“”},     { “value”: 3, codec:“https-mjpeg”, “maxWidth”:320,“maxHeight”:240, “maxBitrateKb”:256 “audio”:“”}    ]     }    }   },  “captureClip”: { //tells camera to capture a video clip    “action”:“operations?method=POST&action=/ui/client/camera/camera-130429zb866913-304/newClip”,    “method”: “post”    },    “captureSnapshot”: { //tellscamera to capture a snapshot / picture   “action”:“operations?method=POST&action=/ui/client/camera/camera-130429zb866913-304/newSnapshot”,   “method”: “post”    }   }  },  { //SECOND CAMERA  “id”:  “camera-34”,   “devIndex”: 34,   “name”:  “Another Cam”,  “tags”: “camera,ip”, // Values: “ip”=for ip devices; “camera”=forcameras   “clipChannel”: 1,   “state”: {   “icon”:  “devStatOffline”,  “statusTxt”: “Offline”   }   //Note there are no commands because thiscam is offline   }  ] }

Note that if camera audio is supported, the values will populate theaudio attribute with the codec to expect in that channel stream, fromthese possible values:

“G.711alaw”, “G.711ulaw”, “G.726”, “G.729”, “G.729a”, “G.729b”, “PCM”,“MP3”, “AC3”, “AAC”, “ADPCM” “camera”: { ...     “options”: [ //for thiscamera and site, audio is enabled      { “value”: 1,codec:“rtspHttps-mpeg”, “maxWidth”:640,      “maxHeight”:320,“maxBitrateKb”:256, “audio”:“AAC” },      { “value”: 2,codec:“https-mjpeg”,  “maxWidth”:640,      “maxHeight”:320,“maxBitrateKb”:512, “audio”:“AAC” },      { “value”: 3,codec:“https-mjpeg”,  “maxWidth”:320,      “maxHeight”:240,“maxBitrateKb”:256, “audio”:“AAC” }     ] ... }Group: energyMeter

The energyMeter group provides basic data for 2 flavors of energydevices: energy-only (like whole-home meters), and combo devices (likelights that report energy). Like hvwData, they seem to overlap, but someof the state values are different.

See FIG. 40.

“energyMeter”: {  “id”:   “energyMeter”,  “name”:  “Energy”,  “icon”: “symEnergy”,  “statusTxt”: “28.3kW”, //this is for a summary / liveicon. If you have a WHM, shows that value, else blank.  “numTrouble”: 0, “items”: [   {   “id”:  “energyMeter-34”,   “devIndex”: “16”,   “name”: “Whole Home Meter”,    “tags”:  “zw,energyMeter,whm”, // Values:“zw”=for ZW devices; “energyMeter”=for energyMeter; “whm”=for whole homemeters    “state”: {   “icon”:“devStatEnergyWHMOn”,//devStatOKenergyWHM, devStatUnknown,devStatOffline, devStatInstalling (this is WHOLE HOME meter)  “statusTxt”: “1.2 kW”, //“Off”, “5.3 W”, “264 W”, “1.6 kW”, “Unknown”,“Offline”, “Installing”   “troubleTxt”: “”, //“”, “Unknown”, “Offline”,“Installing”   “detailTxt”:  “”, //raw text for rendered energy, such as“12”   “shortUnitTxt”: “””, //short unit text “w” for watts, “kW” forkilowatts   “longUnitTxt”: “””, //long unit text “watts” or “kilowatts”  “level”: 1207.3 //raw value, always in watts, as float (as in 9.3 or0.5)    }   },   {    “id”:  “energyMeter-17”,    “devIndex”: “17”,   “name”:  “EM: Upstairs Light”,    “tags”:  “zw,energyMeter”,  //Values: “zw”=for ZW devices; “energyMeter”=for energyMeter; “whm”=forwhole home meters    “state”: {   “icon”:“devStatEnergyOn”,//devStatOKenergy, devStatUnknown, devStatOffline,devStatInstalling (this is regular meter)   “statusTxt”: “28 w”,//“Off”, “5.3 W”, “264 W”, “1.6 kW”, “Unknown”, “Offline”, “Installing”  “troubleTxt”: “”,  //“”, “Unknown”, “Offline”, “Installing”  “detailTxt”: “”,  //raw text for rendered energy, such as “12”  “shortUnitTxt”: “””, //short unit text “w” for watts, “kW” forkilowatts   “longUnitTxt”: “””, //long unit text “watts” or “kilowatts”  “level”: 28.0  //raw value, always in watts, as float (as in 9.3 or0.5)    }  }  ] }

//Example of using energy data:

var energyStatusTxt=client.energyMeter.items [0].state.statusTxt;myDiv.innerHTML=energyStatusTxt;

Hardware/Touch Screen Specific Views and Commands

There are 3 additional objects used when our app runs on a unique client(typically a TS). They are

-   -   clientHardwareInfo—ready-only, this tells us about versions and        levels that cannot be changed    -   clientHardwareControl—read/write, gives state and allows        changing hardware settings such as backlight, volume etc.    -   external Widgets—provides list of widgets and command to launch        them    -   emergency—list of available security panel emergency buttons        clientHardwareInfo

“clientHardwareInfo”: { //top level is stuff that is not expect tochange between reboots or upgrades  “id”: “clientHardwareInfo”,   //allthese properties are just text, fairly static  “firmwareVer”:“5.5.0-12881debug”,  “OSVer”: “5.0.0-13”,  “flashVer”: “5.5.0-12881”, “gatewayVer”: “5.0.1-131”,  “panelName”: “DSC PowerSeries”, “panelFirmwareVer”: “PC1864 v4.51.1.25 p1.28 TL260GSSM v2.01.1.15p1.28”,  “androidOSVer: “2.2”,  “kernelBuild”: “2.6.32.9-release-01”, “modelNumber”: “ventana”,  “ipAddress”: “192.168.107.123”,  “BSSID”:“00:c0:02:5d:54:34”,  “SSID”: “iHub_0060350367ff”,  “macid”:“40:2c:f4:a1:8a:ff”,  “state”: { // stuff that is expected to changeduring session. I think the only UI is battery, wifi, and cell strengthicons   “isOnAC”: true,   “batteryPct”: .75,   “batteryIsCharging”:false, //true if device plugged in and battery is charging (even iffully charged)   “wifiPct”: .8, //float: 0-1 means % wifi strength, −1means unknown or not using wifi   “isOnWifi”:  true, //false if BB cableplugged in   “cellStrengthPct”:  .5,   “internetIsAvailable”: true,//can we access the internet (for example, internet widgets avail)  }, }clientHardwareControl

“clientHardwareControl”: {   “id”: “clientHardwareControl”,   “state”: {  “brightness”: 100,   “led”:   true, //true if hardware LED should showpanel state   “volume”:  80,   “nightMode”: false,   “theme”: 0,  //idof user-preferred bg image. App will use to select folder (theme0) whichcontains bg.jpg, style.css etc.   “emergencyBtnVisibility”: true,//whether to display emergency btn on this particular touch screen  “screenSaverSettings”: { //data for local screen saver. Default isdisabled+empty: {“seconds”:−1,“items”:[ ]}    “seconds”: 900, //numberof idle seconds before screen saver begins. If −1, disables screen saver   “items”: [  //array holds list of items and how long to show each   {“type”: “externalWidgets”, “id”:“com.mobilesrepublic.appytable”,“seconds”:120},    {“type”: “externalWidgets”, “id”:“com.foo”,“seconds”:120}    ]   }   },   “commands”: {   “setBrightness”: {  //need UI to set this    “action”: “setClientHardwareControl”,   “method”: “API_BRIDGE”,    “busyStatusTxt”: “Adjusting...”   “params”: {    “brightness”:{     “type”: “range”,     “min”: 0,    “max”: 100,     “step”: 1,     “labels”: [     { “value”: “default”,“label”: “{0}%”     }     ]    }   },   “setLED”: {    “label”: “TurnOff”,    “action”: “setClientHardwareControl?led=false”,    “method”:“API_BRIDGE”,    “busyStatusTxt”: “Turning Off...”   },  “setNightMode”: { // need UI to send this command    “label”: “NightMode On”,    “action”: “setClientHardwareControl?nightMode=true”,   “method”: “API_BRIDGE”,    “busyStatusTxt”: “Entering night mode(note: you can also do this by swiping down)...”   },   “setTheme”: { //need UI to change this    “action”: “setClientHardwareControl”,   “method”: “API_BRIDGE”,    “params”: {    “theme”: {     “type”:“range”,     “min”: 0, //App will use theme # to select folder(theme0,theme1...) which contains bg.jpg, style.css etc.     “max”: 2,    “step”: 1,     “labels”: [     { “value”: 0, “label”: “Grass” },//localized labels are optional, not sure UX design will require it    { “value”: 1, “label”: “Water” },     { “value”: 2, “label”: “Snow”}     ]    }    }   },   “setEmergencyBtnVisibility”: { // this commandtoggles whether to show or hide the emergency btn (setsemergency.state.disabled)    “label”: “Hide”,  //label for the actionbutton    “action”:“setClientHardwareControl?emergencyBtnVisibility=false”,  //Note: VMwill save this local preference    “method”: “API_BRIDGE”   },  “setScreenSaverSettings”: {    “label”: “Set up”,  //label for theEditor button. Client has custom editor to set up values    “action”:“setClientHardwareControl”, //Note: VM will save this local preference   “method”: “API_BRIDGE”    “params”: {    “screenSaverSettings”: {//see value def'ns above inclientHardwareControl.state.screenSaverSettings     “type”: “textInput”,    “regExp”: “.*”,     “minChars”: 25,     “maxChars”: 99999,    “defaultValue”: {“seconds”:−1,“items”:[ ]}    }    }   },  “testScreenSaver”: { // this command enables “preview” of screensaver, skipping the initial seconds    “label”: “Preview”,  //label forthe action button    “action”:“setClientHardwareControl?testScreenSaver=true”,    “method”:“API_BRIDGE”   },   “setVolume”: { // need UI to change this   “action”: “setClientHardwareControl”,    “method”: “API_BRIDGE”,   “params”: {    “volume”: {    “type”: “range”,    “min”: 0,    “max”:100,     “step”: 1,     “labels”: [     { “value”: “default”, “label”:“{0}%” }     ]    }    }   },   “playSound”: {    “action”:“setClientHardwareControl”,    “method”: “API_BRIDGE”,    “params”: {   “playSoundId”: {     “type”: “select”,     “options”: [     {“value”: “navBtnSound”, “label”: “Nav Button” },     { “value”:“homeBtnSound”, “label”: “Home Button” },     { “value”: “keyBtnSound”,“label”: “Keyboard Button” },     { “value”: “orbBtnSound”, “label”:“Orb Sound” }     ]    }    }   },   //“pauseInput”: { //DEPRECATED, wecan do this feature 100% in HTML!!   // “action”: “pauseInput”, //stopaccepting touch inputs for 10 seconds - clean-screen   // “method”:“API_BRIDGE”   // },   //“returnToApp”: {  //this is called by the appif there's an alarm. It forces the app to the front.   // “action”:“returnToApp”,   // “method”: “API_BRIDGE”   //}   } }externalWidgets

“externalWidgets”: {  “id”: “externalWidgets”,  “items”: [  {  “id”: “com.android.deskclock”,   “label”: “Alarm Clock”,   “iconPath”:“clock_icon.png”,   “commands”: {   “launchWidget”: {   “action”: “launchApp?id=com.android.deskclock”,   “method”: “API_BRIDGE”   }   }  },  {   “id”:“com.mobilesrepublic.appytable”,   “label”: “News Republic”,  “iconPath”: “NewsRepublic_icon.png”,   “commands”: {   “launchWidget”:{    “action”: “launchApp?id=com.mobilesrepublic.appytable”,   “method”: “API_BRIDGE”   }   }  }  ] }Emergency

  “emergency”: {   “id”:    “emergency”,   “state”: {   “label”:    “Emergency”, //this is the label for the primary button   “secondsToHold”: 2,     //required seconds before we send the command   “disabled”:  false,   //if primary button is disabled   “busy”:   false   //if primary button is busy   },   “items”: [    {   “label”: “Fire”,    “icon”: “symEmergencyFire”,    “commands”: {    “panelAction”: {     “action”:“operations?method=POST&action=/ui/client/security/sendEmergency?emergency=Fire”,    “method”: “post”,     “busyStatusTxt”: “Sending Emergency Fire...”    }    }    },    {    “label”: “Police”,    “icon”:“symEmergencyPolice”,    “commands”: {     “panelAction”: {    “action”:“operations?method=POST&action=/ui/client/security/sendEmergency?emergency=Police”,    “method”: “post”,     “busyStatusTxt”: “Sending Emergency Police...”    }    }    },    {    “label”: “Personal”,    “icon”:“symEmergencyPersonal”,    “commands”: {     “panelAction”: {    “action”:“operations?method=POST&action=/ui/client/security/sendEmergency?emergency=Personal”,    “method”: “post”,     “busyStatusTxt”: “Sending EmergencyPersonal...”     }    }    }   ]   }Data Versioning

Clients and VMs may be at different versions, so the APIs and datareturned need to track versions to accommodate several different cases.

In general, major and minor version numbers mean different things:

-   -   Minor version updates are data-additive, so are generally        backward compatible. For example, API version 4.6 may have        additional information that version 4.0 didn't have, but a        client expecting 4.0 can ignore new data elements and should        work OK.    -   Major version updates may be structurally different, so        generally not backward compatible. This can be handled a few        ways (delivering old data to old clients, or force upgrade).

Upon signin, the client should pass the expected API version number. Inthat exchange, there can be several outcomes:

-   -   1. client is major version behind server: the server can reject        the signin and provide the “poison pill” error to the client.        Client prompts user to upgrade before proceeding.    -   2. client is minor version behind server: the server can accept        the signin and return data with same version (if server code can        transform data to backward co) or the minor newer version    -   3. client is same version as server: server returns data with        same version    -   4. client is at minor version newer than server: server returns        data with older version of data. If client is backward        compatible (and has conditional code) it can proceed, or it can        show error to user and stop.    -   5. client is major version newer that server: client shows error        to user and stops.

Our approach is to ensure the server can support one previous majorversion. For example, if the server is at version 4.6, if a 3.1 clientlogs in, the client can return 3.x compatible data, perhaps just oneflavor such as 3.9. The 3.1 client can accept the 3.9 data and proceed,or tell the user and exit the app.

History

History will be stored in its own top level “history” object, adjacentto the top level “client” object described on this page. Seehttps://confluence.icontrol.com/display/DEV/JSON+History+specificationfor details of the history object, its search commands and the format ofevents.

Request and Response Workflows

Basic Client Workflow

To get started, the client will request the entire site.

http://someURL/operations?method=POST&action=foo&value=bar

The response will be a full snapshot describing all of the basic UIelements, and commands to fetch history (but not history data itself).The reponse will be complete, but may omit groups if they are notallowed for that site (for example, if the customer did not pay forcameras). There also may be empty groups if things are allowed but notinstalled.

Site Object has been Returned! for Example, My Site:

-   -   has lights    -   thermos are allowed but none are installed    -   cameras are not allowed    -   homeview is allowed but has not been defined

 “updates”: {   “count”:1,   “ts”:13561152223,   “version”: 2.1, //vers.of data model provided by server (client req vers. was passed at sessioncreation or signin)   “update”: [   {    “ts”:1356115222362,    “type”:“replaceall”, //clean start, replace ALL data with new data    “data”: {   “client”: {     “actionURI”:“/mobile/rest/icontrol/client/0060350419d7/”, //any actions should beappended to this (if they don't start with / )     “site”:  {...},    “summary”:  {...},     “security”: {...},     “shift”: {...}    “messaging”: {...},     “hvwSettings”: {     “id”: “hvwSettings”,    “type”: homeviewSettings,     “show”: false,   //in this example,homeview is allowed but not shown, so we don't have the raw values orhvwData obj     “commands”: {  //but we do have a command to turn it on     “showHomeview”: {      “action”: “foo/bar/showHomeView=true”     “label”: “Turn On”     }     },     “lighting”: {     “id”:“lighting”,     “numTrouble”: 0,     “icon”: “devStatOKlight”,     “items”: [      //Lights are allowed, and we have lights      {     “id”: “lighting-17      ...      }     ]     },     “thermostat”: {    “id”:   “thermostat”,     “items”: [ ]       //show the thermostattab, but there are none installed     }    }, // update[0].data.client   “operations”:{    } // update[0].data.operations    “history”: {    }// update[0].data.history    } // update[0].data    } // update[0]   ]// update array   }

After the full snapshot is received, the client can request deltas fromthat snapshot, using the previous timestamp returned above.

Sample Client Delta Update Request

POST /rest/icontrol/ui/updates?since=13561152223&linger=40000

The next delta update will ONLY include items that have changed sincethe last request. For example, imagine one sensor has changed state, sowe′d get that atom alone.

Sensor “Front Door” Just Closed!

 “updates”: {  “ts”: “13561152231”,  “count”:1,  “update”: [   {  “ts”: “13561152229”,   “type”: “merge”, //there are 2 types of update:replace (a complete item) and merge (merge in the attributes)   “data”:{   //in this case, merge is incomplete: only replace the   changedattributes here   “client”: {    “sensor”: { //a door closed, so updateonly that one zone    “items”: [     {     “id”:  “sensor-34”,    “state”: {      “icon”:  “devStatOk”,      “statusTxt”: “Closed”,     “sort”:  0  //Sort order 50-90 are “interesting” sensors (may beseparated). 0-40 are “quiet”     }     }    ]    },    “summary”: {   “state”: { //Note: this is sparse since most attributes (likeicon=disarmed) have NOT changed     “numTrouble”: 0,    “numOpen”:   0, //was 1, but last door was closed so update     to 0    “sensorStatusTxt”: “All Quiet.”,    }    }   }   }  }  }

Note that there's no list object, only the item that changed. The iconand statusTxt have changed, and the sort position has changed so itshould be inserted in the client list and the list redrawn.

Occasionally, a device may be added or removed since our snapshot. Thenwe will get a new group object, with items added or removed. Forexample, if ALL the energy devices were deleted (but are still possible,e.g. the Energy tab should show in a client, we′d get an updated list“energyMeter” but the list of items would be empty.

Installer has Deleted My Energy Devices!

“updates”: {  “ts”: “126894231203”,  “count”:1,  “update”: { “ts”: “13561152229”,  “type”: “relaceobject”,  “data”: {   “client”: {  “energyMeter”: {    “id”:  “energyMeter”,    “name”:  “Energy”,   “statusTxt”: “No Energy Devices Installed”,    “items”: []        //empty items array because none are    installed   }   }  }  }}

This tells the client they can show an empty list of energy devices,with the status text provided.

One other optimization is well suited for mobile. To speed up initiallogin, we can request a full snapshot, but without the item listsincluded:

POST /rest/icontrol/ui/updates?exclude=items

In this case, we′d get all the top-level singletons and groups, but nodetailed items list. This would allow us to draw and badge the atomsquickly without needing to fetch all the details. Then we can requestagain to lazy-load the full snapshot after login is complete.

Data Update Types

There are several type of updates the server can provide (they cannot berequested). To goal is to minimize the scope of updates to ensure themost efficient data transfer. There are two basic update types: replaceand merge. Replace is used to add, remove, or do a major update to partof the object tree. Merge is intended to replace existing values in thetree with new values

Specifically, there are 3 types of replaces, plus merge. Here's whenthey might be used:

-   -   replaceall—the entire client object should be replace with the        new one. Typically sent on initial request, site change etc.    -   replaceobject—a top level singleton or group object within        client should be replaced. Sent when singletons change, troubles        occur, or devices added/deleted.    -   replaceitem—a single item in an item array with an object should        be replaced. Sent when commands change an entire item.    -   merge—multiple values within existing tree should be overlayed        with new values. Sent for simple state changes like door opens,        light goes on etc.

For example, on initial update call, the entire client tree will bereturned. And if the user changes site.

“update”: [  {  “ts”: “13561152229”,  “type”: “replaceall”, //this isthe entire client object  “data”: {   “client”: {    “summary”: {...},   “security”: {...},    “shift”: {...},    “messages”: {...},   “security”: {...},    “sensors”: {...},    “cameras”: {...}, } } } ]

For smaller updates (deltas) the server will provide a sparse contextfor that action, meaning all the parent objects are there. For example,if you arm the security panel, 2 top-level objects will be replaced.

“update”: [  {  “ts”: “13561152229”,  “type”: “replaceobject”, //thisreplaces only the top level objects  defined  “data”: {   “client”: {  “summary”: {...}, //I armed the system, so only summary & security  need to be replaced   “security”: {...}   }  }  } ]

There can also be a combination of updates. For example, if a dooropens, we couple replace the summary object plus the sensor item:

“update”: [  {  “ts”: “13561152229”,  “type”: “replaceobject”, //newsummary object  “data”: {   “client”: {   “id”:   “summary”,  “name”:   “Security”,   “state”: {    “systemIcon”:  “disarmed”,   “numTrouble”: 0,    “numOpen”:  1,    “numMotion”:  0,   “statusTxt”:  “Disarmed.”,    “sensorStatusTxt”: “1 Sensor Open.”   }} } }, { “ts”: “13561152229”, “type”: “replaceitem”, //only replace onesensor “data”: { “client”: { “sensors”: { “items”: [ { “id”:“sensor-34”, “devIndex”: 34, “zone”: 9, “name”: “Front Door”, “tags”:“sensor”, // Values: “sensor” “state”: { “icon”: “devStatOpen”,“statusTxt”: “Open”, “lastEvent”: “Today, 1:a7pm”, “sort”: 50,“bypassed”: false }, “commands”: {...} } ] } } } } ]

But the most efficient way to do this is with a sparse merge. Then weonly provide replacement values where they've changed:

“update”: [  {  “ts”: “13561152229”,  “type”: “merge”,  “data”: {  “client”: {   “summary”: {    “state”: {    “numOpen”:   1,   “sensorStatusTxt”: “1 Sensor Open.” //only these changed    }   } “sensors”: {    “items”: [    {     “id”: “sensor-34”, //need uniqueidentifier for item     “state”: {     “icon”: “devStatOpen”, //allthese states changed     “statusTxt”: “Open”,     “lastEvent”: “Today,1:17pm”,     “sort”: 50     },    } ]   }   }  }  } ]Command Processing and Operation Queues

For each session, a client can send commands, indicate that thosefeatures are “busy”, and the server will let the client know when thecommand succeeds or fails. The server will provide a separate“operation” object that allows the client to match each command requestwith later success or failure.

When a command is submitted by UI to the Rest service using the actionui provided in data model:

-   -   If the command request is successful, i.e. command is accepted        by server as valid command and server is going to further        process it; server will respond with a http status 200 and id        for the command. Every time a command is successfully accepted a        unique ID is provided by the server.    -   If the command request fails then server will respond with http        status of error.    -   When the command completes, the client will get back a success        or failure operation update. If successful, they can also expect        an client data update with the new state.    -   Operations expire after 30 minutes (server removes from queue).        If a full delta snapshot is requested, operation will only be        provided over 30 minutes (whether succeeded or failed)

For example, if this was the command to lock a door (value=1):

Sample Client Command Request

POSToperations?method=POST&action=/ui/client/doorLock/doorLock-27/setLock&value=1

If the command request was rejected (for example, if a parameter wasincorrect or missing), we'll get back a failed status+message:

   HTTP status code = 200 {  “id”: 3353,  “ts”: 34053345830945, “status”: “failed”,  “statusTxt”: “Unable to lock ‘Front Door Lock’” }

If the command request was successful, we'll get back an HTTP responseproviding a command ID:

   HTTP status code = 200 { //http response body  “id”: 3353,  “ts”:34053345830945,  “status”: “pending” }

The client should queue that ID.

If execution succeeds after a few seconds, client will get an updatewith the new client state data, AND an operation update with success forthat command ID:

 “updates”: {  “count”:1,  “ts”:13561152223,  “update”: [   {  “ts”:1356115222362,   “type”: “merge”,   “data”: {    “client”: {   “lock”: {     “items”: [     {      “id”: “doorLock-27”,     “state”: {      “icon”:  “devStatOKlock”,      “statusTxt”:“Locked”      }     }     ]    }    }, // updates.update[0].data.client   “operations”: {    “operation”: [     {     “id”: 3353,     “ts”:34053345830947,     “status”: “success”     }    ]    } //update[0].data.operations   } // update[0].data   } // update[0]  ] //update array  }

If the command fails after a few seconds, the client will get an updatewith “failed” status for that operation ID. Note there is no clientupdate.

“updates”: {  “count”:1,  “ts”:13561152223,  “update”: [  {  “ts”:1356115222362,   “type”: “merge”,   “data”: {   “operations”: {  “operation”: [    {    “id”: 3353,    “ts”: 34053345830947,   “status”: “failed”,    “statusTxt”: “Unable to lock ‘Front DoorLock’”    }    ] //update[0].data.operations.operation[0]   } //update[0].data.operations   } // update[0].data  } // update[0]  ] //update array  }Client Side Command Workflow

A client may be told a command succeeds or failed, but it also may getno update if there's a communication or other problem. So here's atypical flow for client command/operation tracking:

-   -   1. send command, get back operation ID    -   2. start a timer with that command ID to reset things if no        operation update comes for that ID    -   3. for the device being changed, make a back copy of the current        state for that device (e.g., copy state to pendingState)    -   4. modify current local state to busy icon/busy text (provided        by command)    -   5. update the UI to indicate device is busy

Now we wait. We may get an operation update from the server, or ourlocal timer could time out. There are 3 possible outcomes:

-   -   If we get back an operation delta with success for that command        ID, kill the timer and clear the command from client queue.    -   If we get back an operation delta with failure for that ID, kill        the timer and reset the local state. Alert user to failure with        error statusTxt provided.    -   If the timer times out with NO operation delta for that ID        (still considered pending), kill the timer and reset the local        state with no error alert

What is claimed is:
 1. A system comprising: a touchscreen device locatedat a premises, wherein the touchscreen device is in communication with apremises management device located at the premises, wherein thetouchscreen device comprises a user interface configured to output atleast one control icon for local control of one or more settings of thepremises management device; and a computing device in communication withthe touchscreen device and in communication with a remote device,wherein the computing device is located external to the premises, andwherein the computing device is configured to: receive, via a remoteclient interface and from the remote device, a command associated withthe one or more settings of the premises management device; based on thecommand, send, to the touchscreen device, an indication of the command;receive, from the touchscreen device, touchscreen device data; and basedon a time period from sending of the indication of the command andreceipt of the touchscreen device data, send, to the remote device andvia the remote client interface, a notification indicative of a successor a failure of the command.
 2. The system of claim 1, wherein thecomputing device is further configured to modify, based on the failureof the command, the one or more settings of the premises managementdevice by overwriting a local control of the one or more settings. 3.The system of claim 1, wherein the computing device is configured tosend, to the touchscreen device, the indication of the command at a timeinterval, until the receipt of the touchscreen device data.
 4. Thesystem of claim 1, wherein the computing device is further configured toenable the remote device to modify the one or more settings of thepremises management device by synchronizing the user interface and theremote client interface.
 5. The system of claim 1, wherein thetouchscreen device comprises a first touchscreen device, wherein thesystem further comprises a second touchscreen device located at a secondpremises, and wherein the computing device is further configured to:normalize the touchscreen device data and second data from the secondtouchscreen device; and enable the remote device to access, via theremote client interface, the normalized touchscreen device data andsecond data.
 6. The system of claim 5, wherein the computing device isfurther configured to enable the remote device to control, via theremote client interface, the first touchscreen device.
 7. A methodcomprising: receiving, by a computing device located external to apremises and from a remote device located external to the premises, acommand associated with one or more settings of a premises managementdevice via a remote client interface, wherein the premises managementdevice is located at the premises; based on the command, sending, to alocal device in communication with the premises management device, anindication of the command; receiving, from the local device, localdevice data; and based on a time period from the sending the indicationof the command and the receiving the local device data, sending, to theremote device and via the remote client interface, a notificationindicative of a success or a failure of the command.
 8. The method ofclaim 7, wherein the method further comprises: determining that thecommand has a higher priority than a local command; and based on thedetermining that the command has a higher priority than the localcommand, causing termination of the local command and causing, based onthe command, execution of a functionality of the premises managementdevice.
 9. The method of claim 7, wherein the failure of the commandcomprises a determination that the premises management device is busy.10. The method of claim 7, further comprising sending, to the remotedevice, an indication of a current state of the premises managementdevice.
 11. A computing device comprising: one or more processors; andmemory storing instructions that, when executed by the one or moreprocessors, cause the computing device to: receive, from a remote devicelocated external to a premises and via a remote client interface, acommand associated with one or more settings of a premises managementdevice located at the premises, wherein the computing device is locatedexternal to the premises; based on the command, send, to a local devicein communication with the premises management device, an indication ofthe command; receive, from the local device, local device data; andbased on a time period from sending of the indication of the command andreceipt of the local device data, send, to the remote device and via theremote client interface, a notification indicative of a success or afailure of the command.
 12. The computing device of claim 11, whereinthe premises management device comprises at least one of a home securitydevice or a home automation device.
 13. The computing device of claim11, wherein the one or more settings are associated with at least one ofan arm state or a power state of the premises management device.
 14. Thecomputing device of claim 11, wherein the instructions, when executed bythe one or more processors, further cause the computing device to storethe command in a queue for a period of time, wherein the period of timeis based at least on the time period from the sending the indication ofthe command and the receipt of the local device data.
 15. The computingdevice of claim 11, wherein the premises management device comprises atleast one of a sensor device, a lock device, a lighting device, atemperature control device, or a camera device.
 16. The computing deviceof claim 11, wherein the instructions, when executed by the one or moreprocessors, further cause the computing device to send an indication ofa current state of the premises management device.
 17. The system ofclaim 1, wherein the failure of the command comprises a failure of thetouchscreen device to modify, based on the command, the one or moresettings of the premises management device.
 18. The system of claim 1,wherein the success of the command comprises a modification, by thetouchscreen device and based on the command, of the one or more settingsof the premises management device.
 19. The method of claim 7, whereinthe success of the command comprises execution, by the local device andbased on the command, of the command.
 20. The computing device of claim11, wherein the success of the command is associated with the localdevice data comprising a response to the indication of the command.